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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v1/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

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

    The service_sid

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

    The channel_sid

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

    The sid



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 284

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 account_sid.

Returns:

  • (String) —

    The account_sid



335
336
337
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 335

def 
  @properties['account_sid']
end

#channel_sid ⇒ String

Returns The channel_sid.

Returns:

  • (String) —

    The channel_sid



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

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:



315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 315

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_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MemberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



403
404
405
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 403

def delete
  context.delete
end

#fetch ⇒ MemberInstance

Fetch a MemberInstance

Returns:



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

def fetch
  context.fetch
end

#identity ⇒ String

Returns The identity.

Returns:

  • (String) —

    The identity



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



428
429
430
431
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 428

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

#last_consumed_message_index ⇒ String

Returns The last_consumed_message_index.

Returns:

  • (String) —

    The last_consumed_message_index



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

def last_consumed_message_index
  @properties['last_consumed_message_index']
end

#last_consumption_timestamp ⇒ Time

Returns The last_consumption_timestamp.

Returns:

  • (Time) —

    The last_consumption_timestamp



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

def last_consumption_timestamp
  @properties['last_consumption_timestamp']
end

#role_sid ⇒ String

Returns The role_sid.

Returns:

  • (String) —

    The role_sid



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

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



329
330
331
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 329

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



421
422
423
424
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 421

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

#update(role_sid: :unset, last_consumed_message_index: :unset) ⇒ MemberInstance

Update the MemberInstance

Parameters:

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

    The role_sid

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

    The last_consumed_message_index

Returns:



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

def update(role_sid: :unset, last_consumed_message_index: :unset)
  context.update(
      role_sid: role_sid,
      last_consumed_message_index: last_consumed_message_index,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end