Class: Twilio::REST::Chat::V2::ServiceContext::ChannelContext::MemberList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Chat::V2::ServiceContext::ChannelContext::MemberList
- Defined in:
- lib/twilio-ruby/rest/chat/v2/service/channel/member.rb
Instance Method Summary collapse
-
#create(identity: nil, role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :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
26 27 28 29 30 31 32 |
# File 'lib/twilio-ruby/rest/chat/v2/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, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :unset) ⇒ MemberInstance
Create the MemberInstance
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 68 def create(identity: nil, role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :unset) data = Twilio::Values.of({ 'Identity' => identity, 'RoleSid' => role_sid, 'LastConsumedMessageIndex' => , 'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(), 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created), 'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated), 'Attributes' => attributes, }) headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, }) payload = @version.create('POST', @uri, data: data, headers: headers) 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.
136 137 138 139 140 141 142 143 144 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 136 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.
175 176 177 178 179 180 181 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 175 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.
105 106 107 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 105 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.
157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 157 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.
124 125 126 127 128 129 130 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 124 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
185 186 187 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 185 def to_s '#<Twilio.Chat.V2.MemberList>' end |