Class: Google::Apis::FcmV1::AndroidNotification

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AndroidNotification

Returns a new instance of AndroidNotification.



347
348
349
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 347

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

Returns:

  • (String) 


133
134
135
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 133

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

Returns:

  • (Array<String>) 


141
142
143
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 141

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

Returns:

  • (String) 


148
149
150
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 148

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

Returns:

  • (String) 


160
161
162
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 160

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

Returns:

  • (String) 


167
168
169
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 167

def click_action
  @click_action
end

#color ⇒ String

The notification's icon color, expressed in #rrggbb format. Corresponds to the JSON property color

Returns:

  • (String) 


172
173
174
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 172

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

Returns:

  • (Boolean) 


183
184
185
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 183

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

Returns:

  • (Boolean) 


192
193
194
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 192

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

Returns:

  • (Boolean) 


204
205
206
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 204

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

Returns:

  • (String) 


213
214
215
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 213

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

Returns:

  • (String) 


221
222
223
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 221

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

Returns:

  • (String) 


228
229
230
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 228

def image
  @image
end

#light_settings ⇒ Google::Apis::FcmV1::LightSettings

Settings to control notification LED. Corresponds to the JSON property lightSettings

Returns:



233
234
235
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 233

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

Returns:

  • (Boolean) 


243
244
245
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 243

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

Returns:

  • (Fixnum) 


257
258
259
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 257

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

Returns:

  • (String) 


272
273
274
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 272

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

Returns:

  • (String) 


279
280
281
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 279

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

Returns:

  • (Boolean) 


286
287
288
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 286

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

Returns:

  • (String) 


296
297
298
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 296

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

Returns:

  • (String) 


303
304
305
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 303

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

Returns:

  • (String) 


309
310
311
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 309

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

Returns:

  • (Array<String>) 


317
318
319
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 317

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

Returns:

  • (String) 


324
325
326
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 324

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

Returns:

  • (Array<String>) 


337
338
339
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 337

def vibrate_timings
  @vibrate_timings
end

#visibility ⇒ String

Set the Notification.visibility of the notification. Corresponds to the JSON property visibility

Returns:

  • (String) 


345
346
347
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 345

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 352

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