class Twilio::REST::Conversations::V1::ServiceContext::ParticipantConversationList

Public Class Methods

new(version, chat_service_sid: nil) click to toggle source

Initialize the ParticipantConversationList @param [Version] version Version that contains the resource @param [String] chat_service_sid The unique ID of the {Conversation

Service}[https://www.twilio.com/docs/conversations/api/service-resource] this
conversation belongs to.

@return [ParticipantConversationList] ParticipantConversationList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
22 def initialize(version, chat_service_sid: nil)
23   super(version)
24 
25   # Path Solution
26   @solution = {chat_service_sid: chat_service_sid}
27   @uri = "/Services/#{@solution[:chat_service_sid]}/ParticipantConversations"
28 end

Public Instance Methods

each() { |x| ... } click to toggle source

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

   # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
86 def each
87   limits = @version.read_limits
88 
89   page = self.page(page_size: limits[:page_size], )
90 
91   @version.stream(page,
92                   limit: limits[:limit],
93                   page_limit: limits[:page_limit]).each {|x| yield x}
94 end
get_page(target_url) click to toggle source

Retrieve a single page of ParticipantConversationInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of ParticipantConversationInstance

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
131 def get_page(target_url)
132   response = @version.domain.request(
133       'GET',
134       target_url
135   )
136   ParticipantConversationPage.new(@version, response, @solution)
137 end
list(identity: :unset, address: :unset, limit: nil, page_size: nil) click to toggle source

Lists ParticipantConversationInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [String] identity A unique string identifier for the conversation

participant as {Conversation
User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
parameter is non-null if (and only if) the participant is using the
Conversations SDK to communicate. Limited to 256 characters.

@param [String] address A unique string identifier for the conversation

participant who's not a Conversation User. This parameter could be found in
messaging_binding.address field of Participant resource. It should be
url-encoded.

@param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records.  If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
50 def list(identity: :unset, address: :unset, limit: nil, page_size: nil)
51   self.stream(identity: identity, address: address, limit: limit, page_size: page_size).entries
52 end
page(identity: :unset, address: :unset, page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of ParticipantConversationInstance records from the API. Request is executed immediately. @param [String] identity A unique string identifier for the conversation

participant as {Conversation
User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
parameter is non-null if (and only if) the participant is using the
Conversations SDK to communicate. Limited to 256 characters.

@param [String] address A unique string identifier for the conversation

participant who's not a Conversation User. This parameter could be found in
messaging_binding.address field of Participant resource. It should be
url-encoded.

@param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of ParticipantConversationInstance

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
112 def page(identity: :unset, address: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
113   params = Twilio::Values.of({
114       'Identity' => identity,
115       'Address' => address,
116       'PageToken' => page_token,
117       'Page' => page_number,
118       'PageSize' => page_size,
119   })
120 
121   response = @version.page('GET', @uri, params: params)
122 
123   ParticipantConversationPage.new(@version, response, @solution)
124 end
stream(identity: :unset, address: :unset, limit: nil, page_size: nil) click to toggle source

Streams ParticipantConversationInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [String] identity A unique string identifier for the conversation

participant as {Conversation
User}[https://www.twilio.com/docs/conversations/api/user-resource]. This
parameter is non-null if (and only if) the participant is using the
Conversations SDK to communicate. Limited to 256 characters.

@param [String] address A unique string identifier for the conversation

participant who's not a Conversation User. This parameter could be found in
messaging_binding.address field of Participant resource. It should be
url-encoded.

@param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
74 def stream(identity: :unset, address: :unset, limit: nil, page_size: nil)
75   limits = @version.read_limits(limit, page_size)
76 
77   page = self.page(identity: identity, address: address, page_size: limits[:page_size], )
78 
79   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
80 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
141 def to_s
142   '#<Twilio.Conversations.V1.ParticipantConversationList>'
143 end