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:



138
139
140
141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 138

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



151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 151

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

#fetch ⇒ UserChannelInstance

Fetch the UserChannelInstance

Returns:



162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 162

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



212
213
214
215
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 212

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

#to_s ⇒ Object

Provide a user friendly representation



205
206
207
208
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb', line 205

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:

Returns:



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

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