Class: Twilio::REST::Notify::V1::ServiceContext::NotificationInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Notify::V1::ServiceContext::NotificationInstance

Defined in:

lib/twilio-ruby/rest/notify/v1/service/notification.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Notification resource.

• #action ⇒ String

  The actions to display for the notification.

• #alexa ⇒ Hash

  Deprecated.

• #apn ⇒ Hash

  The APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings.

• #body ⇒ String

  The notification text.

• #data ⇒ Hash

  The custom key-value pairs of the notification’s payload.

• #date_created ⇒ Time

  The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

• #facebook_messenger ⇒ Hash

  Deprecated.

• #fcm ⇒ Hash

  The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings.

• #gcm ⇒ Hash

  The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings.

• #identities ⇒ Array<String>

  The list of ‘identity` values of the Users to notify.

• #initialize(version, payload, service_sid: nil) ⇒ NotificationInstance constructor

  Initialize the NotificationInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #priority ⇒ Priority
• #segments ⇒ Array<String>

  The list of Segments to notify.

• #service_sid ⇒ String

  The SID of the [Service](www.twilio.com/docs/notify/api/service-resource) the resource is associated with.

• #sid ⇒ String

  The unique string that we created to identify the Notification resource.

• #sms ⇒ Hash

  The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings.

• #sound ⇒ String

  The name of the sound to be played for the notification.

• #tags ⇒ Array<String>

  The tags that select the Bindings to notify.

• #title ⇒ String

  The notification title.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #ttl ⇒ String

  How long, in seconds, the notification is valid.

Constructor Details

#initialize(version, payload, service_sid: nil) ⇒ NotificationInstance

Initialize the NotificationInstance

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 159

def initialize(version, payload , service_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'identities' => payload['identities'],
        'tags' => payload['tags'],
        'segments' => payload['segments'],
        'priority' => payload['priority'],
        'ttl' => payload['ttl'] == nil ? payload['ttl'] : payload['ttl'].to_i,
        'title' => payload['title'],
        'body' => payload['body'],
        'sound' => payload['sound'],
        'action' => payload['action'],
        'data' => payload['data'],
        'apn' => payload['apn'],
        'gcm' => payload['gcm'],
        'fcm' => payload['fcm'],
        'sms' => payload['sms'],
        'facebook_messenger' => payload['facebook_messenger'],
        'alexa' => payload['alexa'],
    }
end

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 196

def account_sid
    @properties['account_sid']
end

#action ⇒ String

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 262

def action
    @properties['action']
end

#alexa ⇒ Hash

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 304

def alexa
    @properties['alexa']
end

#apn ⇒ Hash

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 274

def apn
    @properties['apn']
end

#body ⇒ String

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 250

def body
    @properties['body']
end

#data ⇒ Hash

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 268

def data
    @properties['data']
end

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 208

def date_created
    @properties['date_created']
end

#facebook_messenger ⇒ Hash

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 298

def facebook_messenger
    @properties['facebook_messenger']
end

#fcm ⇒ Hash

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 286

def fcm
    @properties['fcm']
end

#gcm ⇒ Hash

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 280

def gcm
    @properties['gcm']
end

#identities ⇒ Array<String>

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 214

def identities
    @properties['identities']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 316

def inspect
    "<Twilio.Notify.V1.NotificationInstance>"
end

#priority ⇒ Priority

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 232

def priority
    @properties['priority']
end

#segments ⇒ Array<String>

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 226

def segments
    @properties['segments']
end

#service_sid ⇒ String

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 202

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 190

def sid
    @properties['sid']
end

#sms ⇒ Hash

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 292

def sms
    @properties['sms']
end

#sound ⇒ String

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 256

def sound
    @properties['sound']
end

#tags ⇒ Array<String>

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 220

def tags
    @properties['tags']
end

#title ⇒ String

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 244

def title
    @properties['title']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 310

def to_s
    "<Twilio.Notify.V1.NotificationInstance>"
end

#ttl ⇒ String

# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 238

def ttl
    @properties['ttl']
end