Class: Twilio::REST::Chat::V2::ServiceContext::UserContext::UserChannelInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, user_sid: nil, channel_sid: nil) ⇒ UserChannelInstance

Initialize the UserChannelInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the [Service](www.twilio.com/docs/chat/rest/services) the User Channel resource is associated with.

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

    The SID of the [User](www.twilio.com/docs/chat/rest/users) the User Channel belongs to.

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

    The SID of the [Channel](www.twilio.com/docs/chat/channels) that has the User Channel to fetch. This value can be either the ‘sid` or the `unique_name` of the Channel to fetch.



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 254

def initialize(version, payload, service_sid: nil, user_sid: nil, channel_sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'channel_sid' => payload['channel_sid'],
      'user_sid' => payload['user_sid'],
      'member_sid' => payload['member_sid'],
      'status' => payload['status'],
      'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
      'unread_messages_count' => payload['unread_messages_count'] == nil ? payload['unread_messages_count'] : payload['unread_messages_count'].to_i,
      'links' => payload['links'],
      'url' => payload['url'],
      'notification_level' => payload['notification_level'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



299
300
301
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 299

def 
  @properties['account_sid']
end

#channel_sid ⇒ String

Returns The SID of the Channel the resource belongs to.

Returns:

  • (String) —

    The SID of the Channel the resource belongs to



311
312
313
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 311

def channel_sid
  @properties['channel_sid']
end

#context ⇒ UserChannelContext

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

Returns:



285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 285

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

#fetch ⇒ UserChannelInstance

Fetch a UserChannelInstance

Returns:



366
367
368
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 366

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



388
389
390
391
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 388

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

#last_consumed_message_index ⇒ String

Returns The index of the last Message in the Channel the Member has read.

Returns:

  • (String) —

    The index of the last Message in the Channel the Member has read



335
336
337
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 335

def last_consumed_message_index
  @properties['last_consumed_message_index']
end

#links ⇒ String

Returns Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel.

Returns:

  • (String) —

    Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel



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

def links
  @properties['links']
end

#member_sid ⇒ String

Returns The SID of the User as a Member in the Channel.

Returns:

  • (String) —

    The SID of the User as a Member in the Channel



323
324
325
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 323

def member_sid
  @properties['member_sid']
end

#notification_level ⇒ user_channel.NotificationLevel

Returns The push notification level of the User for the Channel.

Returns:

  • (user_channel.NotificationLevel) —

    The push notification level of the User for the Channel



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

def notification_level
  @properties['notification_level']
end

#service_sid ⇒ String

Returns The SID of the Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the resource is associated with



305
306
307
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 305

def service_sid
  @properties['service_sid']
end

#status ⇒ user_channel.ChannelStatus

Returns The status of the User on the Channel.

Returns:

  • (user_channel.ChannelStatus) —

    The status of the User on the Channel



329
330
331
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 329

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



381
382
383
384
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 381

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

#unread_messages_count ⇒ String

Returns The number of unread Messages in the Channel for the User.

Returns:

  • (String) —

    The number of unread Messages in the Channel for the User



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

def unread_messages_count
  @properties['unread_messages_count']
end

#update(notification_level: nil) ⇒ UserChannelInstance

Update the UserChannelInstance

Parameters:

  • notification_level (user_channel.NotificationLevel) (defaults to: nil) —

    The push notification level to assign to the User Channel. Can be: ‘default` or `muted`.

Returns:



375
376
377
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 375

def update(notification_level: nil)
  context.update(notification_level: notification_level, )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



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

def url
  @properties['url']
end

#user_sid ⇒ String

Returns The SID of the User the User Channel belongs to.

Returns:

  • (String) —

    The SID of the User the User Channel belongs to



317
318
319
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 317

def user_sid
  @properties['user_sid']
end