Class: Twilio::REST::Conversations::V1::ServiceContext::ConversationContext::MessageList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, chat_service_sid: nil, conversation_sid: nil) ⇒ MessageList

Initialize the MessageList



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 26

def initialize(version, chat_service_sid: nil, conversation_sid: nil)
  super(version)

  # Path Solution
  @solution = {chat_service_sid: chat_service_sid, conversation_sid: conversation_sid}
  @uri = "/Services/#{@solution[:chat_service_sid]}/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, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance

Create the MessageInstance



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 56

def create(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, media_sid: :unset, content_sid: :unset, content_variables: :unset, x_twilio_webhook_enabled: :unset)
  data = Twilio::Values.of({
      'Author' => 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,
  })
  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,
      chat_service_sid: @solution[:chat_service_sid],
      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.



121
122
123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 121

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.



158
159
160
161
162
163
164
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 158

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.



92
93
94
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 92

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.



140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 140

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.



109
110
111
112
113
114
115
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 109

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



168
169
170
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 168

def to_s
  '#<Twilio.Conversations.V1.MessageList>'
end