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 Instance 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
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 28 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
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/member.rb', line 40 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.
106 107 108 109 110 111 112 113 114 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.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 MemberInstance records from the API. Request is executed immediately.
144 145 146 147 148 149 150 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 144 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.
72 73 74 75 76 77 78 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 72 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.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 124 def page(identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Identity' => Twilio.serialize_list(identity), '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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
92 93 94 95 96 97 98 99 100 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 92 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
155 156 157 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 155 def to_s '#<Twilio.IpMessaging.V1.MemberList>' end |