Class: Twilio::REST::IpMessaging::V2::ServiceContext::UserContext::UserChannelContext

Inherits:

Twilio::REST::InstanceContext

• Object
• Twilio::REST::InstanceContext
• Twilio::REST::IpMessaging::V2::ServiceContext::UserContext::UserChannelContext

Defined in:

lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb

Instance Method Summary

• #delete ⇒ Boolean

  Deletes the UserChannelInstance.

• #fetch ⇒ UserChannelInstance

  Fetch a UserChannelInstance.

• #initialize(version, service_sid, user_sid, channel_sid) ⇒ UserChannelContext constructor

  Initialize the UserChannelContext.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #to_s ⇒ Object

  Provide a user friendly representation.

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

  Update the UserChannelInstance.

Constructor Details

#initialize(version, service_sid, user_sid, channel_sid) ⇒ UserChannelContext

Initialize the UserChannelContext

Parameters:

• version (Version) —

  Version that contains the resource

• service_sid (String) —

  The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) to fetch the User Channel resource from.

• user_sid (String) —

  The SID of the [User](www.twilio.com/docs/chat/rest/user-resource) to fetch the User Channel resource from. This value can be either the ‘sid` or the `identity` of the User resource.

• channel_sid (String) —

  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.

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 173

def initialize(version, service_sid, user_sid, channel_sid)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, user_sid: user_sid, channel_sid: channel_sid, }
  @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Channels/#{@solution[:channel_sid]}"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the UserChannelInstance

Returns:

• (Boolean) —

  true if delete succeeds, false otherwise

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 205

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ UserChannelInstance

Fetch a UserChannelInstance

Returns:

• (UserChannelInstance) —

  Fetched UserChannelInstance

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 184

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  UserChannelInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      user_sid: @solution[:user_sid],
      channel_sid: @solution[:channel_sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 252

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.IpMessaging.V2.UserChannelContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 245

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.IpMessaging.V2.UserChannelContext #{context}>"
end

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

Update the UserChannelInstance

Parameters:

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

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

• last_consumed_message_index (String) (defaults to: :unset) —

  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.

• last_consumption_timestamp (Time) (defaults to: :unset) —

  The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](www.twilio.com/docs/chat/channels).

Returns:

• (UserChannelInstance) —

  Updated UserChannelInstance

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 221

def update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset)
  data = Twilio::Values.of({
      'NotificationLevel' => notification_level,
      'LastConsumedMessageIndex' => last_consumed_message_index,
      'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  UserChannelInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      user_sid: @solution[:user_sid],
      channel_sid: @solution[:channel_sid],
  )
end