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
183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 183 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
199 200 201 202 203 204 205 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 199 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
210 211 212 213 214 215 216 217 218 219 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 210 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
336 337 338 339 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 336 def inspect context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Conversations.V1.ConversationContext #{context}>" end |
#messages(sid = :unset) ⇒ MessageList, MessageContext
Access the messages
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 292 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
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 273 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
329 330 331 332 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 329 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
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 234 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
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 311 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 |