Class: Google::Apis::FcmV1::AndroidNotification
- Inherits:
-
Object
- Object
- Google::Apis::FcmV1::AndroidNotification
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/fcm_v1/classes.rb,
generated/google/apis/fcm_v1/representations.rb,
generated/google/apis/fcm_v1/representations.rb
Overview
Notification to send to android devices.
Instance Attribute Summary collapse
-
#body ⇒ String
The notification's body text.
-
#body_loc_args ⇒ Array<String>
Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization.
-
#body_loc_key ⇒ String
The key to the body string in the app's string resources to use to localize the body text to the user's current localization.
-
#channel_id ⇒ String
The notification's channel id (new in Android O).
-
#click_action ⇒ String
The action associated with a user click on the notification.
-
#color ⇒ String
The notification's icon color, expressed in #rrggbb format.
-
#default_light_settings ⇒ Boolean
(also: #default_light_settings?)
If set to true, use the Android framework's default LED light settings for the notification.
-
#default_sound ⇒ Boolean
(also: #default_sound?)
If set to true, use the Android framework's default sound for the notification.
-
#default_vibrate_timings ⇒ Boolean
(also: #default_vibrate_timings?)
If set to true, use the Android framework's default vibrate pattern for the notification.
-
#event_time ⇒ String
Set the time that the event in the notification occurred.
-
#icon ⇒ String
The notification's icon.
-
#image ⇒ String
Contains the URL of an image that is going to be displayed in a notification.
-
#light_settings ⇒ Google::Apis::FcmV1::LightSettings
Settings to control notification LED.
-
#local_only ⇒ Boolean
(also: #local_only?)
Set whether or not this notification is relevant only to the current device.
-
#notification_count ⇒ Fixnum
Sets the number of items this notification represents.
-
#notification_priority ⇒ String
Set the relative priority for this notification.
-
#sound ⇒ String
The sound to play when the device receives the notification.
-
#sticky ⇒ Boolean
(also: #sticky?)
When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel.
-
#tag ⇒ String
Identifier used to replace existing notifications in the notification drawer.
-
#ticker ⇒ String
Sets the "ticker" text, which is sent to accessibility services.
-
#title ⇒ String
The notification's title.
-
#title_loc_args ⇒ Array<String>
Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization.
-
#title_loc_key ⇒ String
The key to the title string in the app's string resources to use to localize the title text to the user's current localization.
-
#vibrate_timings ⇒ Array<String>
Set the vibration pattern to use.
-
#visibility ⇒ String
Set the Notification.visibility of the notification.
Instance Method Summary collapse
-
#initialize(**args) ⇒ AndroidNotification
constructor
A new instance of AndroidNotification.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ AndroidNotification
Returns a new instance of AndroidNotification.
330 331 332 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 330 def initialize(**args) update!(**args) end |
Instance Attribute Details
#body ⇒ String
The notification's body text. If present, it will override google.firebase.fcm.
v1.Notification.body.
Corresponds to the JSON property body
131 132 133 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 131 def body @body end |
#body_loc_args ⇒ Array<String>
Variable string values to be used in place of the format specifiers in
body_loc_key to use to localize the body text to the user's current
localization. See Formatting and Styling for more
information.
Corresponds to the JSON property bodyLocArgs
139 140 141 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 139 def body_loc_args @body_loc_args end |
#body_loc_key ⇒ String
The key to the body string in the app's string resources to use to localize
the body text to the user's current localization. See String Resources for more information.
Corresponds to the JSON property bodyLocKey
146 147 148 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 146 def body_loc_key @body_loc_key end |
#channel_id ⇒ String
The notification's channel id (new in Android O). The app must
create a channel with this channel ID before any notification with this
channel ID is received. If you don't send this channel ID in the request, or
if the channel ID provided has not yet been created by the app, FCM uses the
channel ID specified in the app manifest.
Corresponds to the JSON property channelId
156 157 158 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 156 def channel_id @channel_id end |
#click_action ⇒ String
The action associated with a user click on the notification. If specified, an
activity with a matching intent filter is launched when a user clicks on the
notification.
Corresponds to the JSON property clickAction
163 164 165 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 163 def click_action @click_action end |
#color ⇒ String
The notification's icon color, expressed in #rrggbb format.
Corresponds to the JSON property color
168 169 170 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 168 def color @color end |
#default_light_settings ⇒ Boolean Also known as: default_light_settings?
If set to true, use the Android framework's default LED light settings for the
notification. Default values are specified in config.xml. If default_light_settings
is set to true and light_settings
is also
set, the user-specified light_settings
is used instead of the default value.
Corresponds to the JSON property defaultLightSettings
177 178 179 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 177 def default_light_settings @default_light_settings end |
#default_sound ⇒ Boolean Also known as: default_sound?
If set to true, use the Android framework's default sound for the notification.
Default values are specified in config.xml.
Corresponds to the JSON property defaultSound
185 186 187 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 185 def default_sound @default_sound end |
#default_vibrate_timings ⇒ Boolean Also known as: default_vibrate_timings?
If set to true, use the Android framework's default vibrate pattern for the
notification. Default values are specified in config.xml. If default_vibrate_timings
is set to true and vibrate_timings
is
also set, the default value is used instead of the user-specified
vibrate_timings
.
Corresponds to the JSON property defaultVibrateTimings
196 197 198 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 196 def default_vibrate_timings @default_vibrate_timings end |
#event_time ⇒ String
Set the time that the event in the notification occurred. Notifications in the
panel are sorted by this time. A point in time is represented using protobuf.
Timestamp.
Corresponds to the JSON property eventTime
205 206 207 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 205 def event_time @event_time end |
#icon ⇒ String
The notification's icon. Sets the notification icon to myicon for drawable
resource myicon. If you don't send this key in the request, FCM displays the
launcher icon specified in your app manifest.
Corresponds to the JSON property icon
212 213 214 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 212 def icon @icon end |
#image ⇒ String
Contains the URL of an image that is going to be displayed in a notification.
If present, it will override google.firebase.fcm.v1.Notification.image.
Corresponds to the JSON property image
218 219 220 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 218 def image @image end |
#light_settings ⇒ Google::Apis::FcmV1::LightSettings
Settings to control notification LED.
Corresponds to the JSON property lightSettings
223 224 225 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 223 def light_settings @light_settings end |
#local_only ⇒ Boolean Also known as: local_only?
Set whether or not this notification is relevant only to the current device.
Some notifications can be bridged to other devices for remote display, such as
a Wear OS watch. This hint can be set to recommend this notification not be
bridged. See Wear OS guides
Corresponds to the JSON property localOnly
232 233 234 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 232 def local_only @local_only end |
#notification_count ⇒ Fixnum
Sets the number of items this notification represents. May be displayed as a
badge count for launchers that support badging.See Notification Badge. For example, this might
be useful if you're using just one notification to represent multiple new
messages but you want the count here to represent the number of total new
messages. If zero or unspecified, systems that support badging use the default,
which is to increment a number displayed on the long-press menu each time a
new notification arrives.
Corresponds to the JSON property notificationCount
245 246 247 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 245 def notification_count @notification_count end |
#notification_priority ⇒ String
Set the relative priority for this notification. Priority is an indication of
how much of the user's attention should be consumed by this notification. Low-
priority notifications may be hidden from the user in certain situations,
while the user might be interrupted for a higher-priority notification. The
effect of setting the same priorities may differ slightly on different
platforms. Note this priority differs from AndroidMessagePriority
. This
priority is processed by the client after the message has been delivered,
whereas AndroidMessagePriority is an FCM concept that
controls when the message is delivered.
Corresponds to the JSON property notificationPriority
259 260 261 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 259 def notification_priority @notification_priority end |
#sound ⇒ String
The sound to play when the device receives the notification. Supports "default"
or the filename of a sound resource bundled in the app. Sound files must
reside in /res/raw/.
Corresponds to the JSON property sound
266 267 268 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 266 def sound @sound end |
#sticky ⇒ Boolean Also known as: sticky?
When set to false or unset, the notification is automatically dismissed when
the user clicks it in the panel. When set to true, the notification persists
even when the user clicks it.
Corresponds to the JSON property sticky
273 274 275 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 273 def sticky @sticky end |
#tag ⇒ String
Identifier used to replace existing notifications in the notification drawer.
If not specified, each request creates a new notification. If specified and a
notification with the same tag is already being shown, the new notification
replaces the existing one in the notification drawer.
Corresponds to the JSON property tag
282 283 284 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 282 def tag @tag end |
#ticker ⇒ String
Sets the "ticker" text, which is sent to accessibility services. Prior to API
level 21 (Lollipop
), sets the text that is displayed in the status bar when
the notification first arrives.
Corresponds to the JSON property ticker
289 290 291 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 289 def ticker @ticker end |
#title ⇒ String
The notification's title. If present, it will override google.firebase.fcm.v1.
Notification.title.
Corresponds to the JSON property title
295 296 297 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 295 def title @title end |
#title_loc_args ⇒ Array<String>
Variable string values to be used in place of the format specifiers in
title_loc_key to use to localize the title text to the user's current
localization. See Formatting and Styling for more
information.
Corresponds to the JSON property titleLocArgs
303 304 305 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 303 def title_loc_args @title_loc_args end |
#title_loc_key ⇒ String
The key to the title string in the app's string resources to use to localize
the title text to the user's current localization. See String Resources for more information.
Corresponds to the JSON property titleLocKey
310 311 312 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 310 def title_loc_key @title_loc_key end |
#vibrate_timings ⇒ Array<String>
Set the vibration pattern to use. Pass in an array of protobuf.Duration to turn on or off the vibrator. The first value
indicates the Duration
to wait before turning the vibrator on. The next
value indicates the Duration
to keep the vibrator on. Subsequent values
alternate between Duration
to turn the vibrator off and to turn the vibrator
on. If vibrate_timings
is set and default_vibrate_timings
is set to true
,
the default value is used instead of the user-specified vibrate_timings
.
Corresponds to the JSON property vibrateTimings
322 323 324 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 322 def vibrate_timings @vibrate_timings end |
#visibility ⇒ String
Set the Notification.visibility of the notification.
Corresponds to the JSON property visibility
328 329 330 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 328 def visibility @visibility end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 335 def update!(**args) @body = args[:body] if args.key?(:body) @body_loc_args = args[:body_loc_args] if args.key?(:body_loc_args) @body_loc_key = args[:body_loc_key] if args.key?(:body_loc_key) @channel_id = args[:channel_id] if args.key?(:channel_id) @click_action = args[:click_action] if args.key?(:click_action) @color = args[:color] if args.key?(:color) @default_light_settings = args[:default_light_settings] if args.key?(:default_light_settings) @default_sound = args[:default_sound] if args.key?(:default_sound) @default_vibrate_timings = args[:default_vibrate_timings] if args.key?(:default_vibrate_timings) @event_time = args[:event_time] if args.key?(:event_time) @icon = args[:icon] if args.key?(:icon) @image = args[:image] if args.key?(:image) @light_settings = args[:light_settings] if args.key?(:light_settings) @local_only = args[:local_only] if args.key?(:local_only) @notification_count = args[:notification_count] if args.key?(:notification_count) @notification_priority = args[:notification_priority] if args.key?(:notification_priority) @sound = args[:sound] if args.key?(:sound) @sticky = args[:sticky] if args.key?(:sticky) @tag = args[:tag] if args.key?(:tag) @ticker = args[:ticker] if args.key?(:ticker) @title = args[:title] if args.key?(:title) @title_loc_args = args[:title_loc_args] if args.key?(:title_loc_args) @title_loc_key = args[:title_loc_key] if args.key?(:title_loc_key) @vibrate_timings = args[:vibrate_timings] if args.key?(:vibrate_timings) @visibility = args[:visibility] if args.key?(:visibility) end |