Class: Twilio::REST::Conversations::V1::ServiceContext::UserContext::UserConversationContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, chat_service_sid, user_sid, conversation_sid) ⇒ UserConversationContext

Initialize the UserConversationContext

Parameters:



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 172

def initialize(version, chat_service_sid, user_sid, conversation_sid)
    super(version)
    

    # Path Solution
    @solution = { chat_service_sid: chat_service_sid, user_sid: user_sid, conversation_sid: conversation_sid,  }
    @uri = "/Services/#{@solution[:chat_service_sid]}/Users/#{@solution[:user_sid]}/Conversations/#{@solution[:conversation_sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the UserConversationInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



185
186
187
188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 185

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

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

#delete_with_metadata ⇒ Boolean

Delete the UserConversationInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 198

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      userConversation_instance = UserConversationInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      UserConversationInstanceMetadata.new(@version, userConversation_instance, response.headers, response.status_code)
end

#fetch ⇒ UserConversationInstance

Fetch the UserConversationInstance

Returns:



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

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    UserConversationInstance.new(
        @version,
        payload,
        chat_service_sid: @solution[:chat_service_sid],
        user_sid: @solution[:user_sid],
        conversation_sid: @solution[:conversation_sid],
    )
end

#fetch_with_metadata ⇒ UserConversationInstance

Fetch the UserConversationInstanceMetadata

Returns:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 238

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    user_conversation_instance = UserConversationInstance.new(
        @version,
        response.body,
        chat_service_sid: @solution[:chat_service_sid],
        user_sid: @solution[:user_sid],
        conversation_sid: @solution[:conversation_sid],
    )
    UserConversationInstanceMetadata.new(
        @version,
        user_conversation_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



346
347
348
349
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 346

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

#to_s ⇒ Object

Provide a user friendly representation



339
340
341
342
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 339

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

#update(notification_level: :unset, last_read_timestamp: :unset, last_read_message_index: :unset) ⇒ UserConversationInstance

Update the UserConversationInstance

Parameters:

  • notification_level (NotificationLevel) (defaults to: :unset)
  • last_read_timestamp (Time) (defaults to: :unset) —

    The date of the last message read in conversation by the user, given in ISO 8601 format.

  • last_read_message_index (String) (defaults to: :unset) —

    The index of the last Message in the Conversation that the Participant has read.

Returns:



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 268

def update(
  notification_level: :unset, 
  last_read_timestamp: :unset, 
  last_read_message_index: :unset
)

    data = Twilio::Values.of({
        'NotificationLevel' => notification_level,
        'LastReadTimestamp' => Twilio.serialize_iso8601_datetime(last_read_timestamp),
        'LastReadMessageIndex' => last_read_message_index,
    })

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

#update_with_metadata(notification_level: :unset, last_read_timestamp: :unset, last_read_message_index: :unset) ⇒ UserConversationInstance

Update the UserConversationInstanceMetadata

Parameters:

  • notification_level (NotificationLevel) (defaults to: :unset)
  • last_read_timestamp (Time) (defaults to: :unset) —

    The date of the last message read in conversation by the user, given in ISO 8601 format.

  • last_read_message_index (String) (defaults to: :unset) —

    The index of the last Message in the Conversation that the Participant has read.

Returns:



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 302

def update_with_metadata(
  notification_level: :unset, 
  last_read_timestamp: :unset, 
  last_read_message_index: :unset
)

    data = Twilio::Values.of({
        'NotificationLevel' => notification_level,
        'LastReadTimestamp' => Twilio.serialize_iso8601_datetime(last_read_timestamp),
        'LastReadMessageIndex' => last_read_message_index,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    user_conversation_instance = UserConversationInstance.new(
        @version,
        response.body,
        chat_service_sid: @solution[:chat_service_sid],
        user_sid: @solution[:user_sid],
        conversation_sid: @solution[:conversation_sid],
    )
    UserConversationInstanceMetadata.new(
        @version,
        user_conversation_instance,
        response.headers,
        response.status_code
    )
end