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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, conversation_sid: nil) ⇒ ParticipantList

Initialize the ParticipantList



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 22

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

  # Path Solution
  @solution = {conversation_sid: conversation_sid}
  @uri = "/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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 61

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, 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.



117
118
119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 117

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.



151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 151

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.



90
91
92
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 90

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.



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 134

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.



105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 105

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



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

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