class Azure::MobileEngagement::Mgmt::V2014_12_01::Models::NotificationOptions

Model object.

Attributes

action_text[RW]

@return [String] The action text is the title of the right button of the alert or the value of the unlock slider, where the value replaces 'unlock' in 'slide to unlock'. 'View' (localized to the preferred language) is used as the default value. The `deliveryTime` property must be set to `any` or `background`.

big_picture[RW]

@return [String] URL of a remote image displayed in expanded notifications on Android 4.1+ devices with the following constraints:

  • The URL length is limited to 2000 characters.

  • The image size must be less than 4 MiB.

  • The following MIME types are supported:

** image/png ** image/jpeg ** image/gif ** image/webp ** image/bmp ** image/x-bmp ** image/x-ms-bmp

  • URL scheme must be HTTP or HTTPS (with valid SSL certificate).

  • Incompatible with `bigText`, only one of the fields can be set.

  • The `notificationType` property must be set to `system`.

big_text[RW]

@return [String] Android 4.1+ only. Multi line message shown in expanded notifications on Android 4.1+ devices. The `notificationType` property must be set to `system`.

sound[RW]

@return [String] iOS only. The name of a sound file in the application bundle. The sound in this file is played as an alert. If the sound file doesn’t exist or default is specified as the value, the default alert sound is played. The audio must be in one of the audio data formats that are compatible with system sounds. The `deliveryTime` property must be set to `any` or `background`.

Private Class Methods

mapper() click to toggle source

Mapper for NotificationOptions class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/notification_options.rb, line 63
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'NotificationOptions',
    type: {
      name: 'Composite',
      class_name: 'NotificationOptions',
      model_properties: {
        big_text: {
          client_side_validation: true,
          required: false,
          serialized_name: 'bigText',
          constraints: {
            MaxLength: 4000
          },
          type: {
            name: 'String'
          }
        },
        big_picture: {
          client_side_validation: true,
          required: false,
          serialized_name: 'bigPicture',
          constraints: {
            MaxLength: 2000
          },
          type: {
            name: 'String'
          }
        },
        sound: {
          client_side_validation: true,
          required: false,
          serialized_name: 'sound',
          type: {
            name: 'String'
          }
        },
        action_text: {
          client_side_validation: true,
          required: false,
          serialized_name: 'actionText',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end