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

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

Instance Method Summary collapse

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 to fetch the User Channel resource from.

  • user_sid (String)

    The SID of the User 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 that has the User Channel to fetch. This value can be either the `sid` or the `unique_name` of the Channel to fetch.


171
172
173
174
175
176
177
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 171

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 (user_channel.WebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete(x_twilio_webhook_enabled: :unset)
  headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })

   @version.delete('DELETE', @uri, headers: headers)
end

#fetchUserChannelInstance

Fetch the UserChannelInstance

Returns:


182
183
184
185
186
187
188
189
190
191
192
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 182

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

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

#inspectObject

Provide a detailed, user friendly representation


244
245
246
247
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 244

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

#to_sObject

Provide a user friendly representation


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

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 (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 in the Channel that the Member has read.

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

    The ISO 8601 timestamp of the last Message read event for the Member within the Channel.

Returns:


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 217

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