Class: Azure::MobileEngagement::Mgmt::V2014_12_01::Models::NotificationOptions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/notification_options.rb

Overview

Model object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#action_text ⇒ String

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`.

Returns:

  • (String) —

    The action text is the title of the right button of



56
57
58
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/notification_options.rb', line 56

def action_text
  @action_text
end

#big_picture ⇒ String

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`.

Returns:

  • (String) —

    URL of a remote image displayed in expanded



39
40
41
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/notification_options.rb', line 39

def big_picture
  @big_picture
end

#big_text ⇒ String

expanded notifications on Android 4.1+ devices. The ‘notificationType` property must be set to `system`.

Returns:

  • (String) —

    Android 4.1+ only. Multi line message shown in



20
21
22
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/notification_options.rb', line 20

def big_text
  @big_text
end

#sound ⇒ String

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`.

Returns:

  • (String) —

    iOS only. The name of a sound file in the application



48
49
50
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/notification_options.rb', line 48

def sound
  @sound
end

Class Method Details

.mapper ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/notification_options.rb', line 63

def self.mapper()
  {
    required: false,
    serialized_name: 'NotificationOptions',
    type: {
      name: 'Composite',
      class_name: 'NotificationOptions',
      model_properties: {
        big_text: {
          required: false,
          serialized_name: 'bigText',
          constraints: {
            MaxLength: 4000
          },
          type: {
            name: 'String'
          }
        },
        big_picture: {
          required: false,
          serialized_name: 'bigPicture',
          constraints: {
            MaxLength: 2000
          },
          type: {
            name: 'String'
          }
        },
        sound: {
          required: false,
          serialized_name: 'sound',
          type: {
            name: 'String'
          }
        },
        action_text: {
          required: false,
          serialized_name: 'actionText',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end