Class: Twilio::REST::Conversations::V1::ServiceContext::ConversationContext
- Inherits:
-
InstanceContext
- Object
- InstanceContext
- Twilio::REST::Conversations::V1::ServiceContext::ConversationContext
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/service/conversation.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb
Defined Under Namespace
Classes: MessageContext, MessageInstance, MessageList, MessagePage, ParticipantContext, ParticipantInstance, ParticipantList, ParticipantPage, WebhookContext, WebhookInstance, WebhookList, WebhookPage
Instance Method Summary collapse
-
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the ConversationInstance.
-
#fetch ⇒ ConversationInstance
Fetch the ConversationInstance.
-
#initialize(version, chat_service_sid, sid) ⇒ ConversationContext
constructor
Initialize the ConversationContext.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#messages(sid = :unset) ⇒ MessageList, MessageContext
Access the messages.
-
#participants(sid = :unset) ⇒ ParticipantList, ParticipantContext
Access the participants.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ ConversationInstance
Update the ConversationInstance.
-
#webhooks(sid = :unset) ⇒ WebhookList, WebhookContext
Access the webhooks.
Constructor Details
#initialize(version, chat_service_sid, sid) ⇒ ConversationContext
Initialize the ConversationContext
200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 200 def initialize(version, chat_service_sid, sid) super(version) # Path Solution @solution = {chat_service_sid: chat_service_sid, sid: sid, } @uri = "/Services/#{@solution[:chat_service_sid]}/Conversations/#{@solution[:sid]}" # Dependents @participants = nil @messages = nil @webhooks = nil end |
Instance Method Details
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the ConversationInstance
267 268 269 270 271 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 267 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 ⇒ ConversationInstance
Fetch the ConversationInstance
276 277 278 279 280 281 282 283 284 285 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 276 def fetch payload = @version.fetch('GET', @uri) ConversationInstance.new( @version, payload, chat_service_sid: @solution[:chat_service_sid], sid: @solution[:sid], ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
362 363 364 365 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 362 def inspect context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Conversations.V1.ConversationContext #{context}>" end |
#messages(sid = :unset) ⇒ MessageList, MessageContext
Access the messages
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 313 def (sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return MessageContext.new(@version, @solution[:chat_service_sid], @solution[:sid], sid, ) end unless @messages @messages = MessageList.new( @version, chat_service_sid: @solution[:chat_service_sid], conversation_sid: @solution[:sid], ) end @messages end |
#participants(sid = :unset) ⇒ ParticipantList, ParticipantContext
Access the participants
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 291 def participants(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return ParticipantContext.new(@version, @solution[:chat_service_sid], @solution[:sid], sid, ) end unless @participants @participants = ParticipantList.new( @version, chat_service_sid: @solution[:chat_service_sid], conversation_sid: @solution[:sid], ) end @participants end |
#to_s ⇒ Object
Provide a user friendly representation
355 356 357 358 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 355 def to_s context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Conversations.V1.ConversationContext #{context}>" end |
#update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ ConversationInstance
Update the ConversationInstance
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/conversation.rb', line 238 def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, x_twilio_webhook_enabled: :unset) data = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created), 'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated), 'Attributes' => attributes, 'MessagingServiceSid' => messaging_service_sid, 'State' => state, 'Timers.Inactive' => timers_inactive, 'Timers.Closed' => timers_closed, 'UniqueName' => unique_name, }) headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, }) payload = @version.update('POST', @uri, data: data, headers: headers) ConversationInstance.new( @version, payload, chat_service_sid: @solution[:chat_service_sid], sid: @solution[:sid], ) end |
#webhooks(sid = :unset) ⇒ WebhookList, WebhookContext
Access the webhooks
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 335 def webhooks(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return WebhookContext.new(@version, @solution[:chat_service_sid], @solution[:sid], sid, ) end unless @webhooks @webhooks = WebhookList.new( @version, chat_service_sid: @solution[:chat_service_sid], conversation_sid: @solution[:sid], ) end @webhooks end |