Class: Google::Apis::FcmV1::AndroidConfig
- Inherits:
-
Object
- Object
- Google::Apis::FcmV1::AndroidConfig
- 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
Android specific options for messages sent through FCM connection server.
Instance Attribute Summary collapse
-
#collapse_key ⇒ String
An identifier of a group of messages that can be collapsed, so that only the last message gets sent when delivery can be resumed.
-
#data ⇒ Hash<String,String>
Arbitrary key/value payload.
-
#direct_boot_ok ⇒ Boolean
(also: #direct_boot_ok?)
If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode.
-
#fcm_options ⇒ Google::Apis::FcmV1::AndroidFcmOptions
Options for features provided by the FCM SDK for Android.
-
#notification ⇒ Google::Apis::FcmV1::AndroidNotification
Notification to send to android devices.
-
#priority ⇒ String
Message priority.
-
#restricted_package_name ⇒ String
Package name of the application where the registration token must match in order to receive the message.
-
#ttl ⇒ String
How long (in seconds) the message should be kept in FCM storage if the device is offline.
Instance Method Summary collapse
-
#initialize(**args) ⇒ AndroidConfig
constructor
A new instance of AndroidConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ AndroidConfig
Returns a new instance of AndroidConfig.
89 90 91 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 89 def initialize(**args) update!(**args) end |
Instance Attribute Details
#collapse_key ⇒ String
An identifier of a group of messages that can be collapsed, so that only
the last message gets sent when delivery can be resumed. A maximum of 4
different collapse keys is allowed at any given time.
Corresponds to the JSON property collapseKey
35 36 37 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 35 def collapse_key @collapse_key end |
#data ⇒ Hash<String,String>
Arbitrary key/value payload. If present, it will override
google.firebase.fcm.v1.Message.data.
Corresponds to the JSON property data
41 42 43 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 41 def data @data end |
#direct_boot_ok ⇒ Boolean Also known as: direct_boot_ok?
If set to true, messages will be allowed to be delivered to the app while
the device is in direct boot mode. See Support Direct Boot
mode.
Corresponds to the JSON property directBootOk
48 49 50 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 48 def direct_boot_ok @direct_boot_ok end |
#fcm_options ⇒ Google::Apis::FcmV1::AndroidFcmOptions
Options for features provided by the FCM SDK for Android.
Corresponds to the JSON property fcmOptions
54 55 56 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 54 def @fcm_options end |
#notification ⇒ Google::Apis::FcmV1::AndroidNotification
Notification to send to android devices.
Corresponds to the JSON property notification
59 60 61 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 59 def notification @notification end |
#priority ⇒ String
Message priority. Can take "normal" and "high" values.
For more information, see Setting the priority of a
message.
Corresponds to the JSON property priority
66 67 68 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 66 def priority @priority end |
#restricted_package_name ⇒ String
Package name of the application where the registration token must match in
order to receive the message.
Corresponds to the JSON property restrictedPackageName
72 73 74 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 72 def restricted_package_name @restricted_package_name end |
#ttl ⇒ String
How long (in seconds) the message should be kept in FCM storage if the
device is offline. The maximum time to live supported is 4 weeks, and the
default value is 4 weeks if not set. Set it to 0 if want to send the
message immediately.
In JSON format, the Duration type is encoded as a string rather than an
object, where the string ends in the suffix "s" (indicating seconds) and
is preceded by the number of seconds, with nanoseconds expressed as
fractional seconds. For example, 3 seconds with 0 nanoseconds should be
encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
be expressed in JSON format as "3.000000001s". The ttl will be rounded down
to the nearest second.
Corresponds to the JSON property ttl
87 88 89 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 87 def ttl @ttl end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
94 95 96 97 98 99 100 101 102 103 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 94 def update!(**args) @collapse_key = args[:collapse_key] if args.key?(:collapse_key) @data = args[:data] if args.key?(:data) @direct_boot_ok = args[:direct_boot_ok] if args.key?(:direct_boot_ok) @fcm_options = args[:fcm_options] if args.key?(:fcm_options) @notification = args[:notification] if args.key?(:notification) @priority = args[:priority] if args.key?(:priority) @restricted_package_name = args[:restricted_package_name] if args.key?(:restricted_package_name) @ttl = args[:ttl] if args.key?(:ttl) end |