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)
  • user_sid (String)
  • channel_sid (String)


141
142
143
144
145
146
147
148
149
# File 'lib/twilio-ruby/rest/ip_messaging/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

#deleteBoolean

Delete the UserChannelInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



153
154
155
156
157
158
159
160
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 153

def delete

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

#fetchUserChannelInstance

Fetch the UserChannelInstance

Returns:



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 165

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

#inspectObject

Provide a detailed, user friendly representation



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

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

#to_sObject

Provide a user friendly representation



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

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 (NotificationLevel) (defaults to: :unset)
  • last_consumed_message_index (String) (defaults to: :unset)
  • last_consumption_timestamp (Time) (defaults to: :unset)

Returns:



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 189

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