Class: Firebase::Admin::Messaging::AndroidNotification

Inherits:

Object

• Object
• Firebase::Admin::Messaging::AndroidNotification

Defined in:

lib/firebase/admin/messaging/android_notification.rb

Overview

Android-specific notification options that can be included in an AndroidConfig.

Instance Attribute Summary

• #body ⇒ String^?

  Body of the Android notification.

• #body_loc_args ⇒ Array<String>^?

  An array of resource keys that will be used in place of the format specifiers in #body_loc_key.

• #body_loc_key ⇒ String^?

  Key of the body string in the app’s string resource to use to localize the body text.

• #channel_id ⇒ String^?

  The Android notification channel id (new in Android O).

• #click_action ⇒ String^?

  Action associated with a user click on the notification.

• #color ⇒ String^?

  Notification icon color in ‘#rrggbb` format.

• #default_light_settings ⇒ Boolean^?

  If set to ‘true`, use the Android framework’s default LED light settings for the notification.

• #default_sound ⇒ Boolean^?

  If set to ‘true`, use the Android framework’s default sound for the notification.

• #default_vibrate_timings ⇒ Boolean^?

  If set to ‘true`, use the Android framework’s default vibrate pattern for the notification.

• #event_time ⇒ Time^?

  For notifications that inform users about events with an absolute time reference, sets the time that the event in the notification occurred.

• #icon ⇒ String^?

  Icon resource for the Android notification.

• #image ⇒ String^?

  URL of an image to be displayed in the notification.

• #light_settings ⇒ LightSettings^?

  Settings to control the notification’s LED blinking rate and color if LED is available on the device.

• #local_only ⇒ Boolean^?

  Sets whether or not this notification is relevant only to the current device.

• #notification_count ⇒ Integer^?

  Sets the number of items this notification represents.

• #priority ⇒ String^?

  Sets the relative priority for this notification.

• #sound ⇒ String^?

  File name of the sound to be played when the device receives the notification.

• #sticky ⇒ Boolean^?

  When set to ‘false` or unset, the notification is automatically dismissed when the user clicks it in the panel.

• #tag ⇒ String^?

  Notification tag.

• #ticker ⇒ String^?

  Sets the “ticker” text, which is sent to accessibility services.

• #title ⇒ String^?

  Title of the Android notification.

• #title_loc_args ⇒ Array<String>^?

  An array of resource keys that will be used in place of the format specifiers in #title_loc_key.

• #title_loc_key ⇒ String^?

  Key of the title string in the app’s string resource to use to localize the title text.

• #vibrate_timings ⇒ Array<Numeric>^?

  Sets the vibration pattern to use.

• #visibility ⇒ String^?

  Sets the visibility of the notification.

Instance Method Summary

• #initialize(title: nil, body: nil, icon: nil, color: nil, sound: nil, tag: nil, image: nil, click_action: nil, body_loc_key: nil, body_loc_args: nil, title_loc_key: nil, title_loc_args: nil, channel_id: nil, ticker: nil, sticky: nil, event_time: nil, local_only: nil, priority: nil, vibrate_timings: nil, default_vibrate_timings: nil, default_sound: nil, light_settings: nil, default_light_settings: nil, visibility: nil, notification_count: nil) ⇒ AndroidNotification constructor

  Initializes an AndroidNotification.

Constructor Details

#initialize(title: nil, body: nil, icon: nil, color: nil, sound: nil, tag: nil, image: nil, click_action: nil, body_loc_key: nil, body_loc_args: nil, title_loc_key: nil, title_loc_args: nil, channel_id: nil, ticker: nil, sticky: nil, event_time: nil, local_only: nil, priority: nil, vibrate_timings: nil, default_vibrate_timings: nil, default_sound: nil, light_settings: nil, default_light_settings: nil, visibility: nil, notification_count: nil) ⇒ AndroidNotification

Initializes an AndroidNotification

# File 'lib/firebase/admin/messaging/android_notification.rb', line 165

def initialize(
  title: nil,
  body: nil,
  icon: nil,
  color: nil,
  sound: nil,
  tag: nil,
  image: nil,
  click_action: nil,
  body_loc_key: nil,
  body_loc_args: nil,
  title_loc_key: nil,
  title_loc_args: nil,
  channel_id: nil,
  ticker: nil,
  sticky: nil,
  event_time: nil,
  local_only: nil,
  priority: nil,
  vibrate_timings: nil,
  default_vibrate_timings: nil,
  default_sound: nil,
  light_settings: nil,
  default_light_settings: nil,
  visibility: nil,
  notification_count: nil
)
  self.title = title
  self.body = body
  self.icon = icon
  self.color = color
  self.sound = sound
  self.tag = tag
  self.image = image
  self.click_action = click_action
  self.body_loc_key = body_loc_key
  self.body_loc_args = body_loc_args
  self.title_loc_key = title_loc_key
  self.title_loc_args = title_loc_args
  self.channel_id = channel_id
  self.ticker = ticker
  self.sticky = sticky
  self.event_time = event_time
  self.local_only = local_only
  self.priority = priority
  self.vibrate_timings = vibrate_timings
  self.default_vibrate_timings = default_vibrate_timings
  self.default_sound = default_sound
  self.light_settings = light_settings
  self.default_light_settings = default_light_settings
  self.visibility = visibility
  self.notification_count = notification_count
end

Instance Attribute Details

#body ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 12

def body
  @body
end

#body_loc_args ⇒ Array<String>^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 46

def body_loc_args
  @body_loc_args
end

#body_loc_key ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 42

def body_loc_key
  @body_loc_key
end

#channel_id ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 61

def channel_id
  @channel_id
end

#click_action ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 38

def click_action
  @click_action
end

#color ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 20

def color
  @color
end

#default_light_settings ⇒ Boolean^?

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

See Also:

• https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml

# File 'lib/firebase/admin/messaging/android_notification.rb', line 122

def default_light_settings
  @default_light_settings
end

#default_sound ⇒ Boolean^?

Returns If set to ‘true`, use the Android framework’s default sound for the notification. Default values are specified in ‘config.xml`.

See Also:

• https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml

# File 'lib/firebase/admin/messaging/android_notification.rb', line 110

def default_sound
  @default_sound
end

#default_vibrate_timings ⇒ Boolean^?

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

See Also:

• https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml

# File 'lib/firebase/admin/messaging/android_notification.rb', line 104

def default_vibrate_timings
  @default_vibrate_timings
end

#event_time ⇒ Time^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 76

def event_time
  @event_time
end

#icon ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 16

def icon
  @icon
end

#image ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 33

def image
  @image
end

#light_settings ⇒ LightSettings^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 115

def light_settings
  @light_settings
end

#local_only ⇒ Boolean^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 82

def local_only
  @local_only
end

#notification_count ⇒ Integer^?

Returns Sets the number of items this notification represents. May be displayed as a badge count for Launchers that support badging. 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.

See Also:

• https://developer.android.com/training/notify-user/badges

# File 'lib/firebase/admin/messaging/android_notification.rb', line 136

def notification_count
  @notification_count
end

#priority ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 89

def priority
  @priority
end

#sound ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 24

def sound
  @sound
end

#sticky ⇒ Boolean^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 71

def sticky
  @sticky
end

#tag ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 29

def tag
  @tag
end

#ticker ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 66

def ticker
  @ticker
end

#title ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 8

def title
  @title
end

#title_loc_args ⇒ Array<String>^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 54

def title_loc_args
  @title_loc_args
end

#title_loc_key ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 50

def title_loc_key
  @title_loc_key
end

#vibrate_timings ⇒ Array<Numeric>^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 97

def vibrate_timings
  @vibrate_timings
end

#visibility ⇒ String^?

# File 'lib/firebase/admin/messaging/android_notification.rb', line 127

def visibility
  @visibility
end