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

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

  • account_sid (String) —

    The SID of the Account that created this Participant resource.

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

    The SID of the Call resource to fetch.



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 277

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  || @properties['service_sid']  ,'session_sid' => session_sid  || @properties['session_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Participant resource.

Returns:



333
334
335
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 333

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:



306
307
308
309
310
311
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 306

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](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created.

Returns:



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

def date_created
    @properties['date_created']
end

#date_deleted ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date when the Participant was removed from the session.

Returns:



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

def date_deleted
    @properties['date_deleted']
end

#date_updated ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ParticipantInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ ParticipantInstance

Fetch the ParticipantInstance

Returns:



402
403
404
405
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 402

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the participant. This value must be 255 characters or fewer. Supports UTF-8 characters. **This value should not have PII.**.

Returns:

  • (String) —

    The string that you assigned to describe the participant. This value must be 255 characters or fewer. Supports UTF-8 characters. **This value should not have PII.**



339
340
341
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 339

def friendly_name
    @properties['friendly_name']
end

#identifier ⇒ String

Returns The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters.

Returns:

  • (String) —

    The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters.



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

def identifier
    @properties['identifier']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash

Returns The URLs to resources related the participant.

Returns:

  • (Hash) —

    The URLs to resources related the participant.



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

def links
    @properties['links']
end

#message_interactions ⇒ message_interactions

Access the message_interactions

Returns:



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

def message_interactions
    context.message_interactions
end

#proxy_identifier ⇒ String

Returns The phone number or short code (masked number) of the participant’s partner. The participant will call or message the partner participant at this number.

Returns:

  • (String) —

    The phone number or short code (masked number) of the participant’s partner. The participant will call or message the partner participant at this number.



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

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.



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

def proxy_identifier_sid
    @properties['proxy_identifier_sid']
end

#service_sid ⇒ String

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

Returns:



327
328
329
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 327

def service_sid
    @properties['service_sid']
end

#session_sid ⇒ String

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

Returns:



321
322
323
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 321

def session_sid
    @properties['session_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Participant resource.

Returns:

  • (String) —

    The unique string that we created to identify the Participant resource.



315
316
317
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 315

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

def url
    @properties['url']
end