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

Inherits:

InstanceContext

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

Defined in:

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

Instance Method Summary

• #delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

  Delete the UserChannelInstance.

• #fetch ⇒ UserChannelInstance

  Fetch the 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 update the User Channel resource in.

• user_sid (String) —

  The SID of the [User](www.twilio.com/docs/chat/rest/user-resource) to update 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) with the User Channel resource to update. This value can be the Channel resource’s ‘sid` or `unique_name`.

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

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(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

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

def delete(
    x_twilio_webhook_enabled: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
    
    
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ UserChannelInstance

Fetch the UserChannelInstance

Returns:

• (UserChannelInstance) —

  Fetched UserChannelInstance

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

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    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/chat/v2/service/user/user_channel.rb', line 230

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

#to_s ⇒ Object

Provide a user friendly representation

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

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

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

Update the UserChannelInstance

Parameters:

• notification_level (NotificationLevel) (defaults to: :unset)
• 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/chat/v2/service/user/user_channel.rb', line 192

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),
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    UserChannelInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        user_sid: @solution[:user_sid],
        channel_sid: @solution[:channel_sid],
    )
end