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 unique SID identifier of the parent [Service](www.twilio.com/docs/proxy/api/service).

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

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

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

    A 34 character string that uniquely identifies this Participant.



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 298

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 Account Sid.

Returns:

  • (String) —

    Account Sid.



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

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:



331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 331

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 date this Participant was created.

Returns:

  • (Time) —

    The date this Participant was created



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

def date_created
  @properties['date_created']
end

#date_deleted ⇒ Time

Returns The date this Participant was removed.

Returns:

  • (Time) —

    The date this Participant was removed



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

def date_deleted
  @properties['date_deleted']
end

#date_updated ⇒ Time

Returns The date this Participant was last updated.

Returns:

  • (Time) —

    The date this Participant was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ParticipantInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ ParticipantInstance

Fetch a ParticipantInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human-readable description of this resource.

Returns:

  • (String) —

    A human-readable description of this resource.



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

def friendly_name
  @properties['friendly_name']
end

#identifier ⇒ String

Returns The phone number of this Participant.

Returns:

  • (String) —

    The phone number of this Participant.



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

def identifier
  @properties['identifier']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs.



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

def links
  @properties['links']
end

#message_interactions ⇒ message_interactions

Access the message_interactions

Returns:



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

def message_interactions
  context.message_interactions
end

#proxy_identifier ⇒ String

Returns Proxy Identifier.

Returns:

  • (String) —

    Proxy Identifier.



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

def proxy_identifier
  @properties['proxy_identifier']
end

#proxy_identifier_sid ⇒ String

Returns Proxy Identifier Sid.

Returns:

  • (String) —

    Proxy Identifier Sid.



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

def proxy_identifier_sid
  @properties['proxy_identifier_sid']
end

#service_sid ⇒ String

Returns Service Sid.

Returns:

  • (String) —

    Service Sid.



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

def service_sid
  @properties['service_sid']
end

#session_sid ⇒ String

Returns Session Sid.

Returns:

  • (String) —

    Session Sid.



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

def session_sid
  @properties['session_sid']
end

#sid ⇒ String

Returns A string that uniquely identifies this Participant.

Returns:

  • (String) —

    A string that uniquely identifies this Participant.



345
346
347
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 345

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
  @properties['url']
end