Class: Twilio::REST::Conversations::V1::ServiceContext::ConversationContext::ParticipantList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, chat_service_sid: nil, conversation_sid: nil) ⇒ ParticipantList

Initialize the ParticipantList

Parameters:

  • version (Version) —

    Version that contains the resource

  • chat_service_sid (String) (defaults to: nil) —

    The SID of the Conversation Service the Participant resource is associated with.

  • conversation_sid (String) (defaults to: nil) —

    The unique ID of the Conversation for this participant.


26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 26

def initialize(version, chat_service_sid: nil, conversation_sid: nil)
  super(version)

  # Path Solution
  @solution = {chat_service_sid: chat_service_sid, conversation_sid: conversation_sid}
  @uri = "/Services/#{@solution[:chat_service_sid]}/Conversations/#{@solution[:conversation_sid]}/Participants"
end

Instance Method Details

#create(identity: :unset, messaging_binding_address: :unset, messaging_binding_proxy_address: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_binding_projected_address: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ ParticipantInstance

Create the ParticipantInstance

Parameters:

  • identity (String) (defaults to: :unset) —

    A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters.

  • messaging_binding_address (String) (defaults to: :unset) —

    The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from an SDK endpoint (see the 'identity' field).

  • messaging_binding_proxy_address (String) (defaults to: :unset) —

    The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the 'identity' field).

  • date_created (Time) (defaults to: :unset) —

    The date that this resource was created.

  • date_updated (Time) (defaults to: :unset) —

    The date that this resource was last updated.

  • attributes (String) (defaults to: :unset) —

    An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set “{}” will be returned.

  • messaging_binding_projected_address (String) (defaults to: :unset) —

    The address of the Twilio phone number that is used in Group MMS. Communication mask for the Conversation participant with Identity.

  • role_sid (String) (defaults to: :unset) —

    The SID of a conversation-level Role to assign to the participant.

  • x_twilio_webhook_enabled (participant.WebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 65

def create(identity: :unset, messaging_binding_address: :unset, messaging_binding_proxy_address: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_binding_projected_address: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset)
  data = Twilio::Values.of({
      'Identity' => identity,
      'MessagingBinding.Address' => messaging_binding_address,
      'MessagingBinding.ProxyAddress' => messaging_binding_proxy_address,
      'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
      'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
      'Attributes' => attributes,
      'MessagingBinding.ProjectedAddress' => messaging_binding_projected_address,
      'RoleSid' => role_sid,
  })
  headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })

  payload = @version.create('POST', @uri, data: data, headers: headers)

  ParticipantInstance.new(
      @version,
      payload,
      chat_service_sid: @solution[:chat_service_sid],
      conversation_sid: @solution[:conversation_sid],
  )
end

#each ⇒ Object

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


126
127
128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 126

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 ParticipantInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ParticipantInstance


160
161
162
163
164
165
166
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 160

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  ParticipantPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists ParticipantInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Array) —

    Array of up to limit results


99
100
101
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 99

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of ParticipantInstance records from the API. Request is executed immediately.

Parameters:

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of ParticipantInstance


143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 143

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  ParticipantPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams ParticipantInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results


114
115
116
117
118
119
120
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 114

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(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


170
171
172
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 170

def to_s
  '#<Twilio.Conversations.V1.ParticipantList>'
end