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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MemberList



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 26

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]}/Members"
end

Instance Method Details

#create(identity: nil, role_sid: :unset) ⇒ MemberInstance

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 46

def create(identity: nil, role_sid: :unset)
  data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })

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

  MemberInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      channel_sid: @solution[:channel_sid],
  )
end

#each ⇒ Object

When passed a block, yields MemberInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 111

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 MemberInstance records from the API. Request is executed immediately.



153
154
155
156
157
158
159
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 153

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  MemberPage.new(@version, response, @solution)
end

#list(identity: :unset, limit: nil, page_size: nil) ⇒ Array

Lists MemberInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



79
80
81
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 79

def list(identity: :unset, limit: nil, page_size: nil)
  self.stream(identity: identity, limit: limit, page_size: page_size).entries
end

#page(identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 133

def page(identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Identity' => Twilio.serialize_list(identity) { |e| e },
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  MemberPage.new(@version, response, @solution)
end

#stream(identity: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams MemberInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 99

def stream(identity: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(identity: identity, 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



163
164
165
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 163

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