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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/notify/v1/service/notification.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the NotificationInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Notification resource.

  • sid (String) —

    The SID of the Call resource to fetch.



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/twilio-ruby/rest/notify/v1/service/notification.rb', line 304

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

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

Returns:



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

def 
    @properties['account_sid']
end

#action ⇒ String

Returns The actions to display for the notification. For APNS, translates to the aps.category value. For GCM, translates to the data.twi_action value. For SMS, this parameter is not supported and is omitted from deliveries to those channels.

Returns:

  • (String) —

    The actions to display for the notification. For APNS, translates to the aps.category value. For GCM, translates to the data.twi_action value. For SMS, this parameter is not supported and is omitted from deliveries to those channels.



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

def action
    @properties['action']
end

#alexa ⇒ Hash

Returns Deprecated.

Returns:

  • (Hash) —

    Deprecated.



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

def alexa
    @properties['alexa']
end

#apn ⇒ Hash

Returns The APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings. This property maps to the APNS Payload item, therefore the aps key must be used to change standard attributes. Adds custom key-value pairs to the root of the dictionary. See the [APNS documentation](developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for more details. We reserve keys that start with twi_ for future use. Custom keys that start with twi_ are not allowed.

Returns:



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

def apn
    @properties['apn']
end

#body ⇒ String

Returns The notification text. For FCM and GCM, translates to data.twi_body. For APNS, translates to aps.alert.body. For SMS, translates to body. SMS requires either this body value, or media_urls attribute defined in the sms parameter of the notification.

Returns:

  • (String) —

    The notification text. For FCM and GCM, translates to data.twi_body. For APNS, translates to aps.alert.body. For SMS, translates to body. SMS requires either this body value, or media_urls attribute defined in the sms parameter of the notification.



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

def body
    @properties['body']
end

#data ⇒ Hash

Returns The custom key-value pairs of the notification’s payload. For FCM and GCM, this value translates to data in the FCM and GCM payloads. FCM and GCM [reserve certain keys](firebase.google.com/docs/cloud-messaging/http-server-ref) that cannot be used in those channels. For APNS, attributes of data are inserted into the APNS payload as custom properties outside of the aps dictionary. In all channels, we reserve keys that start with twi_ for future use. Custom keys that start with twi_ are not allowed and are rejected as 400 Bad request with no delivery attempted. For SMS, this parameter is not supported and is omitted from deliveries to those channels.

Returns:

  • (Hash) —

    The custom key-value pairs of the notification’s payload. For FCM and GCM, this value translates to data in the FCM and GCM payloads. FCM and GCM [reserve certain keys](firebase.google.com/docs/cloud-messaging/http-server-ref) that cannot be used in those channels. For APNS, attributes of data are inserted into the APNS payload as custom properties outside of the aps dictionary. In all channels, we reserve keys that start with twi_ for future use. Custom keys that start with twi_ are not allowed and are rejected as 400 Bad request with no delivery attempted. For SMS, this parameter is not supported and is omitted from deliveries to those channels.



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

def data
    @properties['data']
end

#date_created ⇒ Time

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

Returns:



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

def date_created
    @properties['date_created']
end

#facebook_messenger ⇒ Hash

Returns Deprecated.

Returns:

  • (Hash) —

    Deprecated.



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

def facebook_messenger
    @properties['facebook_messenger']
end

#fcm ⇒ Hash

Returns The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. See the [FCM documentation](firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) for more details. Target parameters to, registration_ids, condition, and notification_key are not allowed in this parameter. We reserve keys that start with twi_ for future use. Custom keys that start with twi_ are not allowed. FCM also [reserves certain keys](firebase.google.com/docs/cloud-messaging/http-server-ref), which cannot be used in that channel.

Returns:

  • (Hash) —

    The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. See the [FCM documentation](firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) for more details. Target parameters to, registration_ids, condition, and notification_key are not allowed in this parameter. We reserve keys that start with twi_ for future use. Custom keys that start with twi_ are not allowed. FCM also [reserves certain keys](firebase.google.com/docs/cloud-messaging/http-server-ref), which cannot be used in that channel.



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

def fcm
    @properties['fcm']
end

#gcm ⇒ Hash

Returns The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. Target parameters to, registration_ids, and notification_key are not allowed. We reserve keys that start with twi_ for future use. Custom keys that start with twi_ are not allowed.

Returns:

  • (Hash) —

    The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. Target parameters to, registration_ids, and notification_key are not allowed. We reserve keys that start with twi_ for future use. Custom keys that start with twi_ are not allowed.



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

def gcm
    @properties['gcm']
end

#identities ⇒ Array<String>

Returns The list of identity values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list.

Returns:

  • (Array<String>) —

    The list of identity values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list.



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

def identities
    @properties['identities']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#priority ⇒ Priority

Returns:

  • (Priority) 


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

def priority
    @properties['priority']
end

#segments ⇒ Array<String>

Returns The list of Segments to notify. The [Segment](www.twilio.com/docs/notify/api/segment-resource) resource is deprecated. Use the tags property, instead.

Returns:



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

def segments
    @properties['segments']
end

#service_sid ⇒ String

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

Returns:



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



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

def sid
    @properties['sid']
end

#sms ⇒ Hash

Returns The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding form parameter of the Twilio [Message](www.twilio.com/docs/sms/api/message-resource) resource. These parameters of the Message resource are supported in snake case format: body, media_urls, status_callback, and max_price. The status_callback parameter overrides the corresponding parameter in the messaging service, if configured. The media_urls property expects a JSON array.

Returns:

  • (Hash) —

    The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding form parameter of the Twilio [Message](www.twilio.com/docs/sms/api/message-resource) resource. These parameters of the Message resource are supported in snake case format: body, media_urls, status_callback, and max_price. The status_callback parameter overrides the corresponding parameter in the messaging service, if configured. The media_urls property expects a JSON array.



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

def sms
    @properties['sms']
end

#sound ⇒ String

Returns The name of the sound to be played for the notification. For FCM and GCM, this Translates to data.twi_sound. For APNS, this translates to aps.sound. SMS does not support this property.

Returns:

  • (String) —

    The name of the sound to be played for the notification. For FCM and GCM, this Translates to data.twi_sound. For APNS, this translates to aps.sound. SMS does not support this property.



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

def sound
    @properties['sound']
end

#tags ⇒ Array<String>

Returns The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property.

Returns:

  • (Array<String>) —

    The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property.



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

def tags
    @properties['tags']
end

#title ⇒ String

Returns The notification title. For FCM and GCM, this translates to the data.twi_title value. For APNS, this translates to the aps.alert.title value. SMS does not support this property. This field is not visible on iOS phones and tablets but appears on Apple Watch and Android devices.

Returns:

  • (String) —

    The notification title. For FCM and GCM, this translates to the data.twi_title value. For APNS, this translates to the aps.alert.title value. SMS does not support this property. This field is not visible on iOS phones and tablets but appears on Apple Watch and Android devices.



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

def title
    @properties['title']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#ttl ⇒ String

Returns How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. SMS does not support this property.

Returns:

  • (String) —

    How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. SMS does not support this property.



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

def ttl
    @properties['ttl']
end