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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Chat::V1::ServiceContext::UserContext::UserChannelInstance

Defined in:

lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb

Instance Method Summary

• #account_sid ⇒ String

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

• #channel_sid ⇒ String

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

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

  Initialize the UserChannelInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #last_consumed_message_index ⇒ String

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

• #links ⇒ Hash

  The absolute URLs of the [Members](www.twilio.com/docs/chat/api/members), [Messages](www.twilio.com/docs/chat/api/messages) , [Invites](www.twilio.com/docs/chat/api/invites) and, if it exists, the last [Message](www.twilio.com/docs/chat/api/messages) for the Channel.

• #member_sid ⇒ String

  The SID of a [Member](www.twilio.com/docs/api/chat/rest/members) that represents the User on the Channel.

• #service_sid ⇒ String

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

• #status ⇒ ChannelStatus
• #to_s ⇒ Object

  Provide a user friendly representation.

• #unread_messages_count ⇒ String

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

Constructor Details

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

Initialize the UserChannelInstance

# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 167

def initialize(version, payload , service_sid: nil, user_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'channel_sid' => payload['channel_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'],
    }
end

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 186

def account_sid
    @properties['account_sid']
end

#channel_sid ⇒ String

# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 198

def channel_sid
    @properties['channel_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 240

def inspect
    "<Twilio.Chat.V1.UserChannelInstance>"
end

#last_consumed_message_index ⇒ String

# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 216

def last_consumed_message_index
    @properties['last_consumed_message_index']
end

#links ⇒ Hash

# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 228

def links
    @properties['links']
end

#member_sid ⇒ String

# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 204

def member_sid
    @properties['member_sid']
end

#service_sid ⇒ String

# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 192

def service_sid
    @properties['service_sid']
end

#status ⇒ ChannelStatus

# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 210

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 234

def to_s
    "<Twilio.Chat.V1.UserChannelInstance>"
end

#unread_messages_count ⇒ String

# File 'lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb', line 222

def unread_messages_count
    @properties['unread_messages_count']
end