Class: Twilio::REST::Chat::V2::ServiceContext::ChannelContext::MemberInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/channel/member.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ MemberInstance

Initialize the MemberInstance

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 Member resource.

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

    The SID of the Call resource to fetch.



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 339

def initialize(version, payload , service_sid: nil, channel_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'channel_sid' => payload['channel_sid'],
        'service_sid' => payload['service_sid'],
        'identity' => payload['identity'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'role_sid' => payload['role_sid'],
        'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
        'last_consumption_timestamp' => Twilio.deserialize_iso8601_datetime(payload['last_consumption_timestamp']),
        'url' => payload['url'],
        'attributes' => payload['attributes'],
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'channel_sid' => channel_sid  || @properties['channel_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 Member resource.

Returns:



382
383
384
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 382

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns The JSON string that stores application-specific data. If attributes have not been set, ‘{}` is returned.

Returns:

  • (String) —

    The JSON string that stores application-specific data. If attributes have not been set, ‘{}` is returned.



442
443
444
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 442

def attributes
    @properties['attributes']
end

#channel_sid ⇒ String

Returns The SID of the [Channel](www.twilio.com/docs/chat/channels) the Member resource belongs to.

Returns:



388
389
390
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 388

def channel_sid
    @properties['channel_sid']
end

#context ⇒ MemberContext

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

Returns:



367
368
369
370
371
372
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 367

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

#date_created ⇒ Time

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

Returns:



406
407
408
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 406

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:



412
413
414
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 412

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MemberInstance

Parameters:

  • x_twilio_webhook_enabled (MemberEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



450
451
452
453
454
455
456
457
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 450

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ MemberInstance

Fetch the MemberInstance

Returns:



462
463
464
465
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 462

def fetch

    context.fetch
end

#identity ⇒ String

Returns The application-defined string that uniquely identifies the resource’s [User](www.twilio.com/docs/chat/rest/user-resource) within the [Service](www.twilio.com/docs/chat/rest/service-resource). See [access tokens](www.twilio.com/docs/chat/create-tokens) for more info.

Returns:



400
401
402
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 400

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



507
508
509
510
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 507

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

#last_consumed_message_index ⇒ String

Returns The index of the last [Message](www.twilio.com/docs/chat/rest/message-resource) in the [Channel](www.twilio.com/docs/chat/channels) that the Member has read.

Returns:



424
425
426
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 424

def last_consumed_message_index
    @properties['last_consumed_message_index']
end

#last_consumption_timestamp ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](www.twilio.com/docs/chat/channels).

Returns:



430
431
432
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 430

def last_consumption_timestamp
    @properties['last_consumption_timestamp']
end

#role_sid ⇒ String

Returns The SID of the [Role](www.twilio.com/docs/chat/rest/role-resource) assigned to the member.

Returns:



418
419
420
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 418

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the Member resource is associated with.

Returns:



394
395
396
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 394

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



376
377
378
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 376

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



500
501
502
503
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 500

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

#update(role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :unset) ⇒ MemberInstance

Update the MemberInstance

Parameters:

Returns:



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 477

def update(
    role_sid: :unset, 
    last_consumed_message_index: :unset, 
    last_consumption_timestamp: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    attributes: :unset, 
    x_twilio_webhook_enabled: :unset
)

    context.update(
        role_sid: role_sid, 
        last_consumed_message_index: last_consumed_message_index, 
        last_consumption_timestamp: last_consumption_timestamp, 
        date_created: date_created, 
        date_updated: date_updated, 
        attributes: attributes, 
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#url ⇒ String

Returns The absolute URL of the Member resource.

Returns:

  • (String) —

    The absolute URL of the Member resource.



436
437
438
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 436

def url
    @properties['url']
end