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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MessageList



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 20

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(body: nil, from: :unset, attributes: :unset) ⇒ MessageInstance

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 38

def create(body: nil, from: :unset, attributes: :unset)
  data = Twilio::Values.of({
      'Body' => body,
      'From' => from,
      'Attributes' => attributes,
  })

  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.



106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 106

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.



146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 146

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.



71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 71

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.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 126

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.



91
92
93
94
95
96
97
98
99
100
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 91

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



156
157
158
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 156

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