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

• #channel_sid ⇒ String

  The SID of the Channel 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 in the Channel the Member has read.

• #links ⇒ String

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

• #member_sid ⇒ String

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

• #service_sid ⇒ String

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

• #status ⇒ user_channel.ChannelStatus

  The status of the User on the Channel.

• #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 165

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 183

def account_sid
  @properties['account_sid']
end

#channel_sid ⇒ String

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

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 237

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 213

def last_consumed_message_index
  @properties['last_consumed_message_index']
end

#links ⇒ String

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

def links
  @properties['links']
end

#member_sid ⇒ String

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

def member_sid
  @properties['member_sid']
end

#service_sid ⇒ String

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

def service_sid
  @properties['service_sid']
end

#status ⇒ user_channel.ChannelStatus

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

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 231

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 219

def unread_messages_count
  @properties['unread_messages_count']
end