Class: Twilio::REST::Proxy::V1::ServiceContext::SessionContext::ParticipantInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

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

Initialize the ParticipantInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the resource’s parent [Service](www.twilio.com/docs/proxy/api/service) resource.

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

    The SID of the parent [Session](www.twilio.com/docs/proxy/api/session) resource.

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

    The Twilio-provided string that uniquely identifies the Participant resource to fetch.



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 304

def initialize(version, payload, service_sid: nil, session_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'session_sid' => payload['session_sid'],
      'service_sid' => payload['service_sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'identifier' => payload['identifier'],
      'proxy_identifier' => payload['proxy_identifier'],
      'proxy_identifier_sid' => payload['proxy_identifier_sid'],
      'date_deleted' => Twilio.deserialize_iso8601_datetime(payload['date_deleted']),
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



369
370
371
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 369

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:



337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 337

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



405
406
407
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 405

def date_created
  @properties['date_created']
end

#date_deleted ⇒ Time

Returns The ISO 8601 date the Participant was removed.

Returns:

  • (Time) —

    The ISO 8601 date the Participant was removed



399
400
401
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 399

def date_deleted
  @properties['date_deleted']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



411
412
413
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 411

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ParticipantInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



437
438
439
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 437

def delete
  context.delete
end

#fetch ⇒ ParticipantInstance

Fetch the ParticipantInstance

Returns:



430
431
432
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 430

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the participant.

Returns:

  • (String) —

    The string that you assigned to describe the participant



375
376
377
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 375

def friendly_name
  @properties['friendly_name']
end

#identifier ⇒ String

Returns The phone number of the Participant.

Returns:

  • (String) —

    The phone number of the Participant



381
382
383
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 381

def identifier
  @properties['identifier']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



457
458
459
460
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 457

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

#links ⇒ String

Returns The URLs to resources related the participant.

Returns:

  • (String) —

    The URLs to resources related the participant



423
424
425
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 423

def links
  @properties['links']
end

#message_interactions ⇒ message_interactions

Access the message_interactions

Returns:



444
445
446
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 444

def message_interactions
  context.message_interactions
end

#proxy_identifier ⇒ String

Returns The phone number or short code of the participant’s partner.

Returns:

  • (String) —

    The phone number or short code of the participant’s partner



387
388
389
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 387

def proxy_identifier
  @properties['proxy_identifier']
end

#proxy_identifier_sid ⇒ String

Returns The SID of the Proxy Identifier assigned to the Participant.

Returns:

  • (String) —

    The SID of the Proxy Identifier assigned to the Participant



393
394
395
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 393

def proxy_identifier_sid
  @properties['proxy_identifier_sid']
end

#service_sid ⇒ String

Returns The SID of the resource’s parent Service.

Returns:

  • (String) —

    The SID of the resource’s parent Service



363
364
365
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 363

def service_sid
  @properties['service_sid']
end

#session_sid ⇒ String

Returns The SID of the resource’s parent Session.

Returns:

  • (String) —

    The SID of the resource’s parent Session



357
358
359
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 357

def session_sid
  @properties['session_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



351
352
353
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 351

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



450
451
452
453
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 450

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

#url ⇒ String

Returns The absolute URL of the Participant resource.

Returns:

  • (String) —

    The absolute URL of the Participant resource



417
418
419
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 417

def url
  @properties['url']
end