Show / Hide Table of Contents

Class AndroidConfig

Android specific options for messages sent through FCM connection server.

Inheritance
object
AndroidConfig
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.FirebaseCloudMessaging.v1.Data
Assembly: Google.Apis.FirebaseCloudMessaging.v1.dll
Syntax
public class AndroidConfig : IDirectResponseSchema

Properties

BandwidthConstrainedOk

Optional. If set to true, messages will be allowed to be delivered to the app while the device is in bandwidth constrained mode.

Declaration
[JsonProperty("bandwidthConstrainedOk")]
public virtual bool? BandwidthConstrainedOk { get; set; }
Property Value
Type Description
bool?

CollapseKey

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.

Declaration
[JsonProperty("collapseKey")]
public virtual string CollapseKey { get; set; }
Property Value
Type Description
string

Data

Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data.

Declaration
[JsonProperty("data")]
public virtual IDictionary<string, string> Data { get; set; }
Property Value
Type Description
IDictionary<string, string>

DirectBootOk

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.

Declaration
[JsonProperty("directBootOk")]
public virtual bool? DirectBootOk { get; set; }
Property Value
Type Description
bool?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FcmOptions

Options for features provided by the FCM SDK for Android.

Declaration
[JsonProperty("fcmOptions")]
public virtual AndroidFcmOptions FcmOptions { get; set; }
Property Value
Type Description
AndroidFcmOptions

Notification

Notification to send to android devices.

Declaration
[JsonProperty("notification")]
public virtual AndroidNotification Notification { get; set; }
Property Value
Type Description
AndroidNotification

Priority

Message priority. Can take "normal" and "high" values. For more information, see Setting the priority of a message.

Declaration
[JsonProperty("priority")]
public virtual string Priority { get; set; }
Property Value
Type Description
string

RestrictedPackageName

Package name of the application where the registration token must match in order to receive the message.

Declaration
[JsonProperty("restrictedPackageName")]
public virtual string RestrictedPackageName { get; set; }
Property Value
Type Description
string

Ttl

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.

Declaration
[JsonProperty("ttl")]
public virtual object Ttl { get; set; }
Property Value
Type Description
object

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX