class Twilio::REST::Conversations::V1::ParticipantConversationList
Public Class Methods
Initialize the ParticipantConversationList
@param [Version] version Version
that contains the resource @return [ParticipantConversationList] ParticipantConversationList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb 18 def initialize(version) 19 super(version) 20 21 # Path Solution 22 @solution = {} 23 @uri = "/ParticipantConversations" 24 end
Public Instance Methods
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/participant_conversation.rb 82 def each 83 limits = @version.read_limits 84 85 page = self.page(page_size: limits[:page_size], ) 86 87 @version.stream(page, 88 limit: limits[:limit], 89 page_limit: limits[:page_limit]).each {|x| yield x} 90 end
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/participant_conversation.rb 127 def get_page(target_url) 128 response = @version.domain.request( 129 'GET', 130 target_url 131 ) 132 ParticipantConversationPage.new(@version, response, @solution) 133 end
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/participant_conversation.rb 46 def list(identity: :unset, address: :unset, limit: nil, page_size: nil) 47 self.stream(identity: identity, address: address, limit: limit, page_size: page_size).entries 48 end
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/participant_conversation.rb 108 def page(identity: :unset, address: :unset, page_token: :unset, page_number: :unset, page_size: :unset) 109 params = Twilio::Values.of({ 110 'Identity' => identity, 111 'Address' => address, 112 'PageToken' => page_token, 113 'Page' => page_number, 114 'PageSize' => page_size, 115 }) 116 117 response = @version.page('GET', @uri, params: params) 118 119 ParticipantConversationPage.new(@version, response, @solution) 120 end
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/participant_conversation.rb 70 def stream(identity: :unset, address: :unset, limit: nil, page_size: nil) 71 limits = @version.read_limits(limit, page_size) 72 73 page = self.page(identity: identity, address: address, page_size: limits[:page_size], ) 74 75 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 76 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb 137 def to_s 138 '#<Twilio.Conversations.V1.ParticipantConversationList>' 139 end