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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, user_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 the resource is associated with.

  • user_sid (String) (defaults to: nil)

    The unique string that we created to identify the User resource.


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# 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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#channel_sidString

Returns The SID of the Channel the resource belongs to.

Returns:

  • (String)

    The SID of the Channel the resource belongs to


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

def channel_sid
  @properties['channel_sid']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#last_consumed_message_indexString

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


213
214
215
# 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

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


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

def links
  @properties['links']
end

#member_sidString

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


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

def member_sid
  @properties['member_sid']
end

#service_sidString

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


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

def service_sid
  @properties['service_sid']
end

#statususer_channel.ChannelStatus

Returns The status of the User on the Channel.

Returns:

  • (user_channel.ChannelStatus)

    The status of the User on the Channel


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

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation


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

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

#unread_messages_countString

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


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

def unread_messages_count
  @properties['unread_messages_count']
end