Class: Twilio::REST::Conversations::V1::ConversationContext::ParticipantInstance

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, conversation_sid: nil, sid: nil) ⇒ ParticipantInstance

Initialize the ParticipantInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique id of the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource) for this participant.

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

    A 34 character string that uniquely identifies this resource.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 287

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'conversation_sid' => payload['conversation_sid'],
      'sid' => payload['sid'],
      'identity' => payload['identity'],
      'messaging_binding' => payload['messaging_binding'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'conversation_sid' => conversation_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique id of the Account responsible for this participant.

Returns:

  • (String) —

    The unique id of the Account responsible for this participant.



320
321
322
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 320

def 
  @properties['account_sid']
end

#context ⇒ ParticipantContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



311
312
313
314
315
316
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 311

def context
  unless @instance_context
    @instance_context = ParticipantContext.new(@version, @params['conversation_sid'], @params['sid'], )
  end
  @instance_context
end

#conversation_sid ⇒ String

Returns The unique id of the Conversation for this participant.

Returns:

  • (String) —

    The unique id of the Conversation for this participant.



326
327
328
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 326

def conversation_sid
  @properties['conversation_sid']
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



350
351
352
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 350

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



356
357
358
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 356

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ParticipantInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



378
379
380
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 378

def delete
  context.delete
end

#fetch ⇒ ParticipantInstance

Fetch a ParticipantInstance

Returns:



385
386
387
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 385

def fetch
  context.fetch
end

#identity ⇒ String

Returns A unique string identifier for the conversation participant as Chat User.

Returns:

  • (String) —

    A unique string identifier for the conversation participant as Chat User.



338
339
340
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 338

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



398
399
400
401
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 398

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Conversations.V1.ParticipantInstance #{values}>"
end

#messaging_binding ⇒ Hash

Returns Information about how this participant exchanges messages with the conversation.

Returns:

  • (Hash) —

    Information about how this participant exchanges messages with the conversation.



344
345
346
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 344

def messaging_binding
  @properties['messaging_binding']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



332
333
334
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 332

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



391
392
393
394
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 391

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Conversations.V1.ParticipantInstance #{values}>"
end

#update(date_created: :unset, date_updated: :unset) ⇒ ParticipantInstance

Update the ParticipantInstance

Parameters:

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

Returns:



371
372
373
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 371

def update(date_created: :unset, date_updated: :unset)
  context.update(date_created: date_created, date_updated: date_updated, )
end

#url ⇒ String

Returns An absolute URL for this participant.

Returns:

  • (String) —

    An absolute URL for this participant.



362
363
364
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb', line 362

def url
  @properties['url']
end