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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, user_sid, conversation_sid) ⇒ UserConversationContext

Initialize the UserConversationContext

Parameters:



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

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

    # Path Solution
    @solution = { user_sid: user_sid, conversation_sid: conversation_sid,  }
    @uri = "/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



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

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



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

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:



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

def fetch

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

#fetch_with_metadata ⇒ UserConversationInstance

Fetch the UserConversationInstanceMetadata

Returns:



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

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,
        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



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

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

#to_s ⇒ Object

Provide a user friendly representation



333
334
335
336
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 333

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:



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 264

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,
        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:



297
298
299
300
301
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
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 297

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,
        user_sid: @solution[:user_sid],
        conversation_sid: @solution[:conversation_sid],
    )
    UserConversationInstanceMetadata.new(
        @version,
        user_conversation_instance,
        response.headers,
        response.status_code
    )
end