class Google::Apis::FcmV1::AndroidNotification
Notification
to send to android devices.
Attributes
The notification's body text. If present, it will override google.firebase.fcm. v1.Notification.body.
Corresponds to the JSON property `body` @return [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](goo.gl/MalYE3) for more information. Corresponds to the JSON property `bodyLocArgs` @return [Array<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](https: //goo.gl/NdFZGI) for more information. Corresponds to the JSON property `bodyLocKey` @return [String]
The [notification's channel id](developer.android.com/guide/topics/ui/ notifiers/notifications#ManageChannels) (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` @return [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` @return [String]
The notification's icon color, expressed in rrggbb format. Corresponds to the JSON property `color` @return [String]
If set to true, use the Android framework's default LED light settings for the notification. Default values are specified in [config.xml](android. googlesource.com/platform/frameworks/base/+/master/core/res/res/values/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` @return [Boolean]
If set to true, use the Android framework's default LED light settings for the notification. Default values are specified in [config.xml](android. googlesource.com/platform/frameworks/base/+/master/core/res/res/values/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` @return [Boolean]
If set to true, use the Android framework's default sound for the notification. Default values are specified in [config.xml](android.googlesource.com/ platform/frameworks/base/+/master/core/res/res/values/config.xml). Corresponds to the JSON property `defaultSound` @return [Boolean]
If set to true, use the Android framework's default sound for the notification. Default values are specified in [config.xml](android.googlesource.com/ platform/frameworks/base/+/master/core/res/res/values/config.xml). Corresponds to the JSON property `defaultSound` @return [Boolean]
If set to true, use the Android framework's default vibrate pattern for the notification. Default values are specified in [config.xml](android. googlesource.com/platform/frameworks/base/+/master/core/res/res/values/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` @return [Boolean]
If set to true, use the Android framework's default vibrate pattern for the notification. Default values are specified in [config.xml](android. googlesource.com/platform/frameworks/base/+/master/core/res/res/values/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` @return [Boolean]
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](developers.google.com/protocol-buffers/docs/reference/java/ com/google/protobuf/Timestamp). Corresponds to the JSON property `eventTime` @return [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` @return [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` @return [String]
Settings to control notification LED. Corresponds to the JSON property `lightSettings` @return [Google::Apis::FcmV1::LightSettings]
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](developer.android.com/training/wearables/ notifications/bridger#existing-method-of-preventing-bridging) Corresponds to the JSON property `localOnly` @return [Boolean]
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](developer.android.com/training/wearables/ notifications/bridger#existing-method-of-preventing-bridging) Corresponds to the JSON property `localOnly` @return [Boolean]
Sets the number of items this notification represents. May be displayed as a badge count for launchers that support badging.See [Notification Badge](https:/ /developer.android.com/training/notify-user/badges). 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` @return [Fixnum]
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](firebase.google.com/docs/reference/ fcm/rest/v1/projects.messages#androidmessagepriority) is an FCM concept that controls when the message is delivered. Corresponds to the JSON property `notificationPriority` @return [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` @return [String]
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` @return [Boolean]
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` @return [Boolean]
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` @return [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` @return [String]
The notification's title. If present, it will override google.firebase.fcm.v1. Notification.title
. Corresponds to the JSON property `title` @return [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](goo.gl/MalYE3) for more information. Corresponds to the JSON property `titleLocArgs` @return [Array<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]( goo.gl/NdFZGI) for more information. Corresponds to the JSON property `titleLocKey` @return [String]
Set the vibration pattern to use. Pass in an array of [protobuf.Duration]( developers.google.com/protocol-buffers/docs/reference/google.protobuf# google.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` @return [Array<String>]
Set the [Notification.visibility](developer.android.com/reference/ android/app/Notification.html#visibility) of the notification. Corresponds to the JSON property `visibility` @return [String]
Public Class Methods
# File lib/google/apis/fcm_v1/classes.rb, line 330 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/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