Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::MessageList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::MessageList
- Defined in:
- lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb
Instance Method Summary collapse
-
#create(from: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, body: :unset, media_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance
Create the MessageInstance.
-
#each ⇒ Object
When passed a block, yields MessageInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of MessageInstance records from the API.
-
#initialize(version, service_sid: nil, channel_sid: nil) ⇒ MessageList
constructor
Initialize the MessageList.
-
#list(order: :unset, limit: nil, page_size: nil) ⇒ Array
Lists MessageInstance records from the API as a list.
-
#page(order: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of MessageInstance records from the API.
-
#stream(order: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams MessageInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, service_sid: nil, channel_sid: nil) ⇒ MessageList
Initialize the MessageList
22 23 24 25 26 27 28 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 22 def initialize(version, service_sid: nil, channel_sid: nil) super(version) # Path Solution @solution = {service_sid: service_sid, channel_sid: channel_sid} @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Messages" end |
Instance Method Details
#create(from: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, body: :unset, media_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance
Create the MessageInstance
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 42 def create(from: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, body: :unset, media_sid: :unset, x_twilio_webhook_enabled: :unset) data = Twilio::Values.of({ 'From' => from, 'Attributes' => attributes, 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created), 'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated), 'LastUpdatedBy' => last_updated_by, 'Body' => body, 'MediaSid' => media_sid, }) headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, }) payload = @version.create('POST', @uri, data: data, headers: headers) MessageInstance.new( @version, payload, service_sid: @solution[:service_sid], channel_sid: @solution[:channel_sid], ) end |
#each ⇒ Object
When passed a block, yields MessageInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
104 105 106 107 108 109 110 111 112 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 104 def each limits = @version.read_limits page = self.page(page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]).each {|x| yield x} end |
#get_page(target_url) ⇒ Page
Retrieve a single page of MessageInstance records from the API. Request is executed immediately.
140 141 142 143 144 145 146 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 140 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) MessagePage.new(@version, response, @solution) end |
#list(order: :unset, limit: nil, page_size: nil) ⇒ Array
Lists MessageInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
76 77 78 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 76 def list(order: :unset, limit: nil, page_size: nil) self.stream(order: order, limit: limit, page_size: page_size).entries end |
#page(order: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of MessageInstance records from the API. Request is executed immediately.
122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 122 def page(order: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Order' => order, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) MessagePage.new(@version, response, @solution) end |
#stream(order: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams MessageInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
92 93 94 95 96 97 98 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 92 def stream(order: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page(order: order, page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) end |
#to_s ⇒ Object
Provide a user friendly representation
150 151 152 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 150 def to_s '#<Twilio.IpMessaging.V2.MessageList>' end |