Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::MessageInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ MessageInstance

Initialize the MessageInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • service_sid (String) (defaults to: nil)

    The service_sid

  • channel_sid (String) (defaults to: nil)

    The channel_sid

  • sid (String) (defaults to: nil)

    The sid


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_sidString

Returns The account_sid.

Returns:

  • (String)

    The account_sid


344
345
346
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 344

def 
  @properties['account_sid']
end

#attributesString

Returns The attributes.

Returns:

  • (String)

    The attributes


350
351
352
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 350

def attributes
  @properties['attributes']
end

#bodyString

Returns The body.

Returns:

  • (String)

    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_sidString

Returns The channel_sid.

Returns:

  • (String)

    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

#contextMessageContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


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_createdTime

Returns The date_created.

Returns:

  • (Time)

    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_updatedTime

Returns The date_updated.

Returns:

  • (Time)

    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

Parameters:

  • x_twilio_webhook_enabled (message.WebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

#fetchMessageInstance

Fetch the MessageInstance

Returns:


435
436
437
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 435

def fetch
  context.fetch
end

#fromString

Returns The from.

Returns:

  • (String)

    The from


398
399
400
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 398

def from
  @properties['from']
end

#indexString

Returns The index.

Returns:

  • (String)

    The index


410
411
412
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 410

def index
  @properties['index']
end

#inspectObject

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_byString

Returns The last_updated_by.

Returns:

  • (String)

    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

#mediaHash

Returns The media.

Returns:

  • (Hash)

    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_sidString

Returns The service_sid.

Returns:

  • (String)

    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

#sidString

Returns The sid.

Returns:

  • (String)

    The sid


338
339
340
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 338

def sid
  @properties['sid']
end

#toString

Returns The to.

Returns:

  • (String)

    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_sObject

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

#typeString

Returns The type.

Returns:

  • (String)

    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

Parameters:

  • body (String) (defaults to: :unset)

    The body

  • attributes (String) (defaults to: :unset)

    The attributes

  • date_created (Time) (defaults to: :unset)

    The date_created

  • date_updated (Time) (defaults to: :unset)

    The date_updated

  • last_updated_by (String) (defaults to: :unset)

    The last_updated_by

  • from (String) (defaults to: :unset)

    The from

  • x_twilio_webhook_enabled (message.WebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:


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

#urlString

Returns The url.

Returns:

  • (String)

    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_editedBoolean

Returns The was_edited.

Returns:

  • (Boolean)

    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