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:



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 296

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'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique id of the Account responsible for this member.

Returns:

  • (String) —

    The unique id of the Account responsible for this member.



347
348
349
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 347

def 
  @properties['account_sid']
end

#channel_sid ⇒ String

Returns The unique id of the Channel for this member.

Returns:

  • (String) —

    The unique id of the Channel for this member.



353
354
355
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 353

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:



327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 327

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 that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MemberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



415
416
417
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 415

def delete
  context.delete
end

#fetch ⇒ MemberInstance

Fetch a MemberInstance

Returns:



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

def fetch
  context.fetch
end

#identity ⇒ String

Returns A unique string identifier for this User in this Service.

Returns:

  • (String) —

    A unique string identifier for this User in this Service.



365
366
367
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 365

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#last_consumed_message_index ⇒ String

Returns An Integer representing index of the last Message this Member has read within this Channel.

Returns:

  • (String) —

    An Integer representing index of the last Message this Member has read within this Channel



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

def last_consumed_message_index
  @properties['last_consumed_message_index']
end

#last_consumption_timestamp ⇒ Time

Returns An ISO8601 based timestamp string representing the datetime of the last Message read event for this Member within this Channel.

Returns:

  • (Time) —

    An ISO8601 based timestamp string representing the datetime of the last Message read event for this Member within this Channel



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

def last_consumption_timestamp
  @properties['last_consumption_timestamp']
end

#role_sid ⇒ String

Returns The Role assigned to this member.

Returns:

  • (String) —

    The Role assigned to this member.



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

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String

Returns The unique id of the Service this member belongs to.

Returns:

  • (String) —

    The unique id of the Service this member belongs to.



359
360
361
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 359

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



341
342
343
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 341

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



445
446
447
448
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 445

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) ⇒ MemberInstance

Update the MemberInstance

Parameters:

  • role_sid (String) (defaults to: :unset) —

    The role to be assigned to this member. Defaults to the roles specified on the [Service](www.twilio.com/docs/api/chat/rest/services).

  • last_consumed_message_index (String) (defaults to: :unset) —

    Optional field used to specify the last consumed Message index for the Channel for this Member.

  • last_consumption_timestamp (Time) (defaults to: :unset) —

    Optional ISO8601 time indicating the last datetime the Member consumed a Message in the Channel.

  • date_created (Time) (defaults to: :unset) —

    The optional ISO8601 time specifying the datetime the Members should be set as being created.

  • date_updated (Time) (defaults to: :unset) —

    The optional ISO8601 time specifying the datetime the Member should be set as having been last updated.

Returns:



433
434
435
436
437
438
439
440
441
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 433

def update(role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :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,
  )
end

#url ⇒ String

Returns An absolute URL for this member.

Returns:

  • (String) —

    An absolute URL for this member.



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

def url
  @properties['url']
end