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

  • account_sid (String) —

    The SID of the Account that created this UserChannel resource.

  • sid (String) —

    The SID of the Call resource to fetch.



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

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

Instance Method Details

#account_sid ⇒ String

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

Returns:



295
296
297
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 295

def 
    @properties['account_sid']
end

#channel_sid ⇒ String

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

Returns:



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

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:



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

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

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the UserChannelInstance

Parameters:

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ UserChannelInstance

Fetch the UserChannelInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



408
409
410
411
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 408

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](www.twilio.com/docs/chat/rest/message-resource) in the [Channel](www.twilio.com/docs/chat/channels) that the Member has read.

Returns:



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

def last_consumed_message_index
    @properties['last_consumed_message_index']
end

#links ⇒ Hash

Returns The absolute URLs of the [Members](www.twilio.com/docs/chat/rest/member-resource), [Messages](www.twilio.com/docs/chat/rest/message-resource) , [Invites](www.twilio.com/docs/chat/rest/invite-resource) and, if it exists, the last [Message](www.twilio.com/docs/chat/rest/message-resource) for the Channel.

Returns:



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

def links
    @properties['links']
end

#member_sid ⇒ String

Returns The SID of a [Member](www.twilio.com/docs/chat/rest/member-resource) that represents the User on the Channel.

Returns:



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

def member_sid
    @properties['member_sid']
end

#notification_level ⇒ NotificationLevel

Returns:

  • (NotificationLevel) 


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

def notification_level
    @properties['notification_level']
end

#service_sid ⇒ String

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

Returns:



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

def service_sid
    @properties['service_sid']
end

#status ⇒ ChannelStatus

Returns:

  • (ChannelStatus) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



401
402
403
404
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 401

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. Note that retrieving messages on a client endpoint does not mean that messages are consumed or read. See [Consumption Horizon feature](www.twilio.com/docs/chat/consumption-horizon) to learn how to mark messages as consumed.

Returns:

  • (String) —

    The number of unread Messages in the Channel for the User. Note that retrieving messages on a client endpoint does not mean that messages are consumed or read. See [Consumption Horizon feature](www.twilio.com/docs/chat/consumption-horizon) to learn how to mark messages as consumed.



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

def unread_messages_count
    @properties['unread_messages_count']
end

#update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset) ⇒ UserChannelInstance

Update the UserChannelInstance

Parameters:

Returns:



386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 386

def update(
    notification_level: :unset, 
    last_consumed_message_index: :unset, 
    last_consumption_timestamp: :unset
)

    context.update(
        notification_level: notification_level, 
        last_consumed_message_index: last_consumed_message_index, 
        last_consumption_timestamp: last_consumption_timestamp, 
    )
end

#url ⇒ String

Returns The absolute URL of the User Channel resource.

Returns:

  • (String) —

    The absolute URL of the User Channel resource.



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

def url
    @properties['url']
end

#user_sid ⇒ String

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

Returns:



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

def user_sid
    @properties['user_sid']
end