class Twilio::REST::Conversations::V1::UserContext::UserConversationContext
Public Class Methods
Initialize the UserConversationContext
@param [Version] version Version
that contains the resource @param [String] user_sid The unique SID identifier of the {User
resource}[https://www.twilio.com/docs/conversations/api/user-resource]. This value can be either the `sid` or the `identity` of the User resource.
@param [String] conversation_sid The unique SID identifier of the Conversation.
This value can be either the `sid` or the `unique_name` of the {Conversation resource}[https://www.twilio.com/docs/conversations/api/conversation-resource].
@return [UserConversationContext] UserConversationContext
Twilio::REST::InstanceContext::new
# File lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb 156 def initialize(version, user_sid, conversation_sid) 157 super(version) 158 159 # Path Solution 160 @solution = {user_sid: user_sid, conversation_sid: conversation_sid, } 161 @uri = "/Users/#{@solution[:user_sid]}/Conversations/#{@solution[:conversation_sid]}" 162 end
Public Instance Methods
Delete the UserConversationInstance
@return [Boolean] true if delete succeeds, false otherwise
# File lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb 193 def delete 194 @version.delete('DELETE', @uri) 195 end
Fetch the UserConversationInstance
@return [UserConversationInstance] Fetched UserConversationInstance
# File lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb 200 def fetch 201 payload = @version.fetch('GET', @uri) 202 203 UserConversationInstance.new( 204 @version, 205 payload, 206 user_sid: @solution[:user_sid], 207 conversation_sid: @solution[:conversation_sid], 208 ) 209 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb 220 def inspect 221 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') 222 "#<Twilio.Conversations.V1.UserConversationContext #{context}>" 223 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb 213 def to_s 214 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') 215 "#<Twilio.Conversations.V1.UserConversationContext #{context}>" 216 end
Update the UserConversationInstance
@param [user_conversation.NotificationLevel] notification_level The Notification
Level of this User Conversation. One of `default` or `muted`.
@param [Time] last_read_timestamp The date of the last message read in
conversation by the user, given in ISO 8601 format.
@param [String] last_read_message_index The index of the last Message in the
Conversation that the Participant has read.
@return [UserConversationInstance] Updated UserConversationInstance
# File lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb 173 def update(notification_level: :unset, last_read_timestamp: :unset, last_read_message_index: :unset) 174 data = Twilio::Values.of({ 175 'NotificationLevel' => notification_level, 176 'LastReadTimestamp' => Twilio.serialize_iso8601_datetime(last_read_timestamp), 177 'LastReadMessageIndex' => last_read_message_index, 178 }) 179 180 payload = @version.update('POST', @uri, data: data) 181 182 UserConversationInstance.new( 183 @version, 184 payload, 185 user_sid: @solution[:user_sid], 186 conversation_sid: @solution[:conversation_sid], 187 ) 188 end