Class: Twilio::REST::IpMessaging::V1::ServiceContext::ChannelContext::MemberList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::IpMessaging::V1::ServiceContext::ChannelContext::MemberList
- Defined in:
- lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb
Instance Method Summary collapse
-
#create(identity: nil, role_sid: :unset) ⇒ MemberInstance
Create the MemberInstance.
-
#each ⇒ Object
When passed a block, yields MemberInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of MemberInstance records from the API.
-
#initialize(version, service_sid: nil, channel_sid: nil) ⇒ MemberList
constructor
Initialize the MemberList.
-
#list(identity: :unset, limit: nil, page_size: nil) ⇒ Array
Lists MemberInstance records from the API as a list.
-
#page(identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of MemberInstance records from the API.
-
#stream(identity: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams MemberInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, service_sid: nil, channel_sid: nil) ⇒ MemberList
Initialize the MemberList
22 23 24 25 26 27 28 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 22 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
Create the MemberInstance
35 36 37 38 39 40 41 42 43 44 45 46 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 35 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.
88 89 90 91 92 93 94 95 96 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 88 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.
124 125 126 127 128 129 130 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 124 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.
60 61 62 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 60 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.
106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 106 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: 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.
76 77 78 79 80 81 82 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 76 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
134 135 136 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 134 def to_s '#<Twilio.IpMessaging.V1.MemberList>' end |