Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::MessageList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, channel_sid: nil) ⇒ MessageList

Initialize the MessageList

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) (defaults to: nil) —

    The unique id of the [Service](www.twilio.com/docs/api/chat/rest/services) this message belongs to.

  • channel_sid (String) (defaults to: nil) —

    The channel_sid



24
25
26
27
28
29
30
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 24

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) ⇒ MessageInstance

Retrieve a single page of MessageInstance records from the API. Request is executed immediately.

Parameters:

  • from (String) (defaults to: :unset) —

    The [identity](www.twilio.com/docs/api/chat/guides/identity) of the message’s author. Defaults to ‘system` if not specified.

  • attributes (String) (defaults to: :unset) —

    A metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.

  • date_created (Time) (defaults to: :unset) —

    The ISO8601 time specifying the datetime the Message should be set as being created. Will be set to the current time by the Chat service if not specified. Note that this should only be used in cases where a Chat’s history is being recreated from a backup/separate source.

  • date_updated (Time) (defaults to: :unset) —

    The ISO8601 time specifying the datetime the Message should be set as having been last updated. Will be set to the ‘null` by the Chat service if not specified. Note that this should only be used in cases where a Chat’s history is being recreated from a backup/separate source and where a Message was previously updated.

  • last_updated_by (String) (defaults to: :unset) —

    Specify the Identity of the User that last updated the Message (if relevant)

  • body (String) (defaults to: :unset) —

    A string message to send to this channel. You can also send structured data by serializing it into a string. May be empty string or ‘null`, will be set as empty string as a result in this cases.

  • media_sid (String) (defaults to: :unset) —

    The [Media](www.twilio.com/docs/api/chat/rest/media) Sid to be attached to this Message.

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 58

def create(from: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, body: :unset, media_sid: :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,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  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.



127
128
129
130
131
132
133
134
135
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 127

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of MessageInstance



167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 167

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.

Parameters:

  • order (message.OrderType) (defaults to: :unset) —

    Specifies sorting order for messages list, possible values are: ‘asc` or `desc`. If no value is specified, then `asc` is used as the default.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



97
98
99
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 97

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.

Parameters:

  • order (message.OrderType) (defaults to: :unset) —

    Specifies sorting order for messages list, possible values are: ‘asc` or `desc`. If no value is specified, then `asc` is used as the default.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of MessageInstance



147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 147

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
  )
  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.

Parameters:

  • order (message.OrderType) (defaults to: :unset) —

    Specifies sorting order for messages list, possible values are: ‘asc` or `desc`. If no value is specified, then `asc` is used as the default.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 115

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



177
178
179
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 177

def to_s
  '#<Twilio.IpMessaging.V2.MessageList>'
end