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

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/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](www.twilio.com/docs/chat/rest/services) to fetch the User Channel resource from.

  • user_sid (String) —

    The SID of the [User](www.twilio.com/docs/chat/rest/users) 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.



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

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

#fetch ⇒ UserChannelInstance

Fetch a UserChannelInstance

Returns:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 183

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



233
234
235
236
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 233

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

#to_s ⇒ Object

Provide a user friendly representation



226
227
228
229
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 226

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

#update(notification_level: nil) ⇒ UserChannelInstance

Update the UserChannelInstance

Parameters:

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

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

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 206

def update(notification_level: nil)
  data = Twilio::Values.of({'NotificationLevel' => notification_level, })

  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