Class: Twilio::REST::Conversations::V1::ConversationContext::MessageList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Conversations::V1::ConversationContext::MessageList
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/conversation/message.rb
Instance Method Summary collapse
-
#create(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, media_sid: :unset, content_sid: :unset, content_variables: :unset, subject: :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, conversation_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 Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, conversation_sid: nil) ⇒ MessageList
Initialize the MessageList
27 28 29 30 31 32 33 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 27 def initialize(version, conversation_sid: nil) super(version) # Path Solution @solution = { conversation_sid: conversation_sid } @uri = "/Conversations/#{@solution[:conversation_sid]}/Messages" end |
Instance Method Details
#create(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, media_sid: :unset, content_sid: :unset, content_variables: :unset, subject: :unset, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance
Create the MessageInstance
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 47 def create( author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, media_sid: :unset, content_sid: :unset, content_variables: :unset, subject: :unset, x_twilio_webhook_enabled: :unset ) data = Twilio::Values.of({ 'Author' => , 'Body' => body, 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created), 'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated), 'Attributes' => attributes, 'MediaSid' => media_sid, 'ContentSid' => content_sid, 'ContentVariables' => content_variables, 'Subject' => subject, }) 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, conversation_sid: @solution[:conversation_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.
128 129 130 131 132 133 134 135 136 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 128 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.
164 165 166 167 168 169 170 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 164 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.
94 95 96 97 98 99 100 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 94 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.
146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 146 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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
114 115 116 117 118 119 120 121 122 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 114 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
175 176 177 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 175 def to_s '#<Twilio.Conversations.V1.MessageList>' end |