Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::MessageInstance
- Inherits:
-
Twilio::REST::InstanceResource
- Object
- Twilio::REST::InstanceResource
- Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::MessageInstance
- Defined in:
- lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The account_sid.
-
#attributes ⇒ String
The attributes.
-
#body ⇒ String
The body.
-
#channel_sid ⇒ String
The channel_sid.
-
#context ⇒ MessageContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date_created.
-
#date_updated ⇒ Time
The date_updated.
-
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the MessageInstance.
-
#fetch ⇒ MessageInstance
Fetch the MessageInstance.
-
#from ⇒ String
The from.
-
#index ⇒ String
The index.
-
#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ MessageInstance
constructor
Initialize the MessageInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#last_updated_by ⇒ String
The last_updated_by.
-
#media ⇒ Hash
The media.
-
#service_sid ⇒ String
The service_sid.
-
#sid ⇒ String
The sid.
-
#to ⇒ String
The to.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#type ⇒ String
The type.
-
#update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, from: :unset, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance
Update the MessageInstance.
-
#url ⇒ String
The url.
-
#was_edited ⇒ Boolean
The was_edited.
Constructor Details
#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ MessageInstance
Initialize the MessageInstance
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 288 def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'attributes' => payload['attributes'], 'service_sid' => payload['service_sid'], 'to' => payload['to'], 'channel_sid' => payload['channel_sid'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'last_updated_by' => payload['last_updated_by'], 'was_edited' => payload['was_edited'], 'from' => payload['from'], 'body' => payload['body'], 'index' => payload['index'].to_i, 'type' => payload['type'], 'media' => payload['media'], 'url' => payload['url'], } # Context @instance_context = nil @params = { 'service_sid' => service_sid, 'channel_sid' => channel_sid, 'sid' => sid || @properties['sid'], } end |
Instance Method Details
#account_sid ⇒ String
Returns The account_sid.
344 345 346 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 344 def account_sid @properties['account_sid'] end |
#attributes ⇒ String
Returns The attributes.
350 351 352 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 350 def attributes @properties['attributes'] end |
#body ⇒ String
Returns The body.
404 405 406 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 404 def body @properties['body'] end |
#channel_sid ⇒ String
Returns The channel_sid.
368 369 370 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 368 def channel_sid @properties['channel_sid'] end |
#context ⇒ MessageContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 324 def context unless @instance_context @instance_context = MessageContext.new( @version, @params['service_sid'], @params['channel_sid'], @params['sid'], ) end @instance_context end |
#date_created ⇒ Time
Returns The date_created.
374 375 376 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 374 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date_updated.
380 381 382 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 380 def date_updated @properties['date_updated'] end |
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the MessageInstance
444 445 446 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 444 def delete(x_twilio_webhook_enabled: :unset) context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, ) end |
#fetch ⇒ MessageInstance
Fetch the MessageInstance
435 436 437 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 435 def fetch context.fetch end |
#from ⇒ String
Returns The from.
398 399 400 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 398 def from @properties['from'] end |
#index ⇒ String
Returns The index.
410 411 412 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 410 def index @properties['index'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
480 481 482 483 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 480 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.IpMessaging.V2.MessageInstance #{values}>" end |
#last_updated_by ⇒ String
Returns The last_updated_by.
386 387 388 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 386 def last_updated_by @properties['last_updated_by'] end |
#media ⇒ Hash
Returns The media.
422 423 424 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 422 def media @properties['media'] end |
#service_sid ⇒ String
Returns The service_sid.
356 357 358 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 356 def service_sid @properties['service_sid'] end |
#sid ⇒ String
Returns The sid.
338 339 340 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 338 def sid @properties['sid'] end |
#to ⇒ String
Returns The to.
362 363 364 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 362 def to @properties['to'] end |
#to_s ⇒ Object
Provide a user friendly representation
473 474 475 476 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 473 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.IpMessaging.V2.MessageInstance #{values}>" end |
#type ⇒ String
Returns The type.
416 417 418 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 416 def type @properties['type'] end |
#update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, from: :unset, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance
Update the MessageInstance
459 460 461 462 463 464 465 466 467 468 469 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 459 def update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, from: :unset, x_twilio_webhook_enabled: :unset) context.update( body: body, attributes: attributes, date_created: date_created, date_updated: date_updated, last_updated_by: last_updated_by, from: from, x_twilio_webhook_enabled: x_twilio_webhook_enabled, ) end |
#url ⇒ String
Returns The url.
428 429 430 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 428 def url @properties['url'] end |
#was_edited ⇒ Boolean
Returns The was_edited.
392 393 394 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 392 def was_edited @properties['was_edited'] end |