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.



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
332
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 305

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



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

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:



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

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



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ParticipantInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ ParticipantInstance

Fetch a ParticipantInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#identifier ⇒ String

Returns The phone number of the Participant.

Returns:

  • (String) —

    The phone number of the Participant



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

def identifier
  @properties['identifier']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

def links
  @properties['links']
end

#message_interactions ⇒ message_interactions

Access the message_interactions

Returns:



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

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



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

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



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

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



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

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



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

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



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def url
  @properties['url']
end