• Home
• com.google.apis
• google-api-services-fcm
• v1-rev20241112-2.0.0
• source code
• index-all.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.index-all.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev
Next


Frames
No Frames


All Classes








A B C D F G I L M N P S W 


A

all() - Static method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingScopes

Returns an unmodifiable set that contains all scopes declared by this class.

AndroidConfig - Class in com.google.api.services.fcm.v1.model

Android specific options for messages sent through [FCM connection
 server](https://goo.gl/4GLdUl).

AndroidConfig() - Constructor for class com.google.api.services.fcm.v1.model.AndroidConfig
 
AndroidFcmOptions - Class in com.google.api.services.fcm.v1.model

Options for features provided by the FCM SDK for Android.

AndroidFcmOptions() - Constructor for class com.google.api.services.fcm.v1.model.AndroidFcmOptions
 
AndroidNotification - Class in com.google.api.services.fcm.v1.model

Notification to send to android devices.

AndroidNotification() - Constructor for class com.google.api.services.fcm.v1.model.AndroidNotification
 
ApnsConfig - Class in com.google.api.services.fcm.v1.model

[Apple Push Notification Service](https://goo.gl/MXRTPa) specific options.

ApnsConfig() - Constructor for class com.google.api.services.fcm.v1.model.ApnsConfig
 
ApnsFcmOptions - Class in com.google.api.services.fcm.v1.model

Options for features provided by the FCM SDK for iOS.

ApnsFcmOptions() - Constructor for class com.google.api.services.fcm.v1.model.ApnsFcmOptions
 




B

build() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder

Builds a new instance of FirebaseCloudMessaging.

Builder(HttpTransport, JsonFactory, HttpRequestInitializer) - Constructor for class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder

Returns an instance of a new builder.





C

clone() - Method in class com.google.api.services.fcm.v1.model.AndroidConfig
 
clone() - Method in class com.google.api.services.fcm.v1.model.AndroidFcmOptions
 
clone() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification
 
clone() - Method in class com.google.api.services.fcm.v1.model.ApnsConfig
 
clone() - Method in class com.google.api.services.fcm.v1.model.ApnsFcmOptions
 
clone() - Method in class com.google.api.services.fcm.v1.model.Color
 
clone() - Method in class com.google.api.services.fcm.v1.model.FcmOptions
 
clone() - Method in class com.google.api.services.fcm.v1.model.LightSettings
 
clone() - Method in class com.google.api.services.fcm.v1.model.Message
 
clone() - Method in class com.google.api.services.fcm.v1.model.Notification
 
clone() - Method in class com.google.api.services.fcm.v1.model.SendMessageRequest
 
clone() - Method in class com.google.api.services.fcm.v1.model.WebpushConfig
 
clone() - Method in class com.google.api.services.fcm.v1.model.WebpushFcmOptions
 
CLOUD_PLATFORM - Static variable in class com.google.api.services.fcm.v1.FirebaseCloudMessagingScopes

See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account..

Color - Class in com.google.api.services.fcm.v1.model

Represents a color in the RGBA color space.

Color() - Constructor for class com.google.api.services.fcm.v1.model.Color
 
com.google.api.services.fcm.v1 - package com.google.api.services.fcm.v1
 
com.google.api.services.fcm.v1.model - package com.google.api.services.fcm.v1.model
 




D

DEFAULT_BASE_URL - Static variable in class com.google.api.services.fcm.v1.FirebaseCloudMessaging

The default encoded base URL of the service.

DEFAULT_BATCH_PATH - Static variable in class com.google.api.services.fcm.v1.FirebaseCloudMessaging

The default encoded batch path of the service.

DEFAULT_MTLS_ROOT_URL - Static variable in class com.google.api.services.fcm.v1.FirebaseCloudMessaging

The default encoded mTLS root URL of the service.

DEFAULT_ROOT_URL - Static variable in class com.google.api.services.fcm.v1.FirebaseCloudMessaging

The default encoded root URL of the service.

DEFAULT_SERVICE_PATH - Static variable in class com.google.api.services.fcm.v1.FirebaseCloudMessaging

The default encoded service path of the service.





F

FcmOptions - Class in com.google.api.services.fcm.v1.model

Platform independent options for features provided by the FCM SDKs.

FcmOptions() - Constructor for class com.google.api.services.fcm.v1.model.FcmOptions
 
FIREBASE_MESSAGING - Static variable in class com.google.api.services.fcm.v1.FirebaseCloudMessagingScopes

Send messages and manage messaging subscriptions for your Firebase applications.

FirebaseCloudMessaging - Class in com.google.api.services.fcm.v1

Service definition for FirebaseCloudMessaging (v1).

FirebaseCloudMessaging(HttpTransport, JsonFactory, HttpRequestInitializer) - Constructor for class com.google.api.services.fcm.v1.FirebaseCloudMessaging

Constructor.

FirebaseCloudMessaging.Builder - Class in com.google.api.services.fcm.v1

Builder for FirebaseCloudMessaging.

FirebaseCloudMessaging.Projects - Class in com.google.api.services.fcm.v1

The "projects" collection of methods.

FirebaseCloudMessaging.Projects.Messages - Class in com.google.api.services.fcm.v1

The "messages" collection of methods.

FirebaseCloudMessaging.Projects.Messages.Send - Class in com.google.api.services.fcm.v1
 
FirebaseCloudMessagingRequest<T> - Class in com.google.api.services.fcm.v1

FirebaseCloudMessaging request.

FirebaseCloudMessagingRequest(FirebaseCloudMessaging, String, String, Object, Class<T>) - Constructor for class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest
 
FirebaseCloudMessagingRequestInitializer - Class in com.google.api.services.fcm.v1

FirebaseCloudMessaging request initializer for setting properties like key and userIp.

FirebaseCloudMessagingRequestInitializer() - Constructor for class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequestInitializer
 
FirebaseCloudMessagingRequestInitializer(String) - Constructor for class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequestInitializer
 
FirebaseCloudMessagingRequestInitializer(String, String) - Constructor for class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequestInitializer
 
FirebaseCloudMessagingScopes - Class in com.google.api.services.fcm.v1

Available OAuth 2.0 scopes for use with the Firebase Cloud Messaging API.





G

get$Xgafv() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

V1 error format.

getAbstractGoogleClient() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest
 
getAccessToken() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

OAuth access token.

getAlpha() - Method in class com.google.api.services.fcm.v1.model.Color

The fraction of this color that should be applied to the pixel.

getAlt() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

Data format for response.

getAnalyticsLabel() - Method in class com.google.api.services.fcm.v1.model.AndroidFcmOptions

Label associated with the message's analytics data.

getAnalyticsLabel() - Method in class com.google.api.services.fcm.v1.model.ApnsFcmOptions

Label associated with the message's analytics data.

getAnalyticsLabel() - Method in class com.google.api.services.fcm.v1.model.FcmOptions

Label associated with the message's analytics data.

getAnalyticsLabel() - Method in class com.google.api.services.fcm.v1.model.WebpushFcmOptions

Label associated with the message's analytics data.

getAndroid() - Method in class com.google.api.services.fcm.v1.model.Message

Input only.

getApns() - Method in class com.google.api.services.fcm.v1.model.Message

Input only.

getBlue() - Method in class com.google.api.services.fcm.v1.model.Color

The amount of blue in the color as a value in the interval [0, 1].

getBody() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The notification's body text.

getBody() - Method in class com.google.api.services.fcm.v1.model.Notification

The notification's body text.

getBodyLocArgs() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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.

getBodyLocKey() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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.

getBypassProxyNotification() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

If set, display notifications delivered to the device will be handled by the app instead of the
 proxy.

getCallback() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

JSONP

getChannelId() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The [notification's channel
 id](https://developer.android.com/guide/topics/ui/notifiers/notifications#ManageChannels) (new
 in Android O).

getClickAction() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The action associated with a user click on the notification.

getCollapseKey() - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

An identifier of a group of messages that can be collapsed, so that only the last message gets
 sent when delivery can be resumed.

getColor() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The notification's icon color, expressed in #rrggbb format.

getColor() - Method in class com.google.api.services.fcm.v1.model.LightSettings

Required.

getCondition() - Method in class com.google.api.services.fcm.v1.model.Message

Condition to send a message to, e.g.

getData() - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

Arbitrary key/value payload.

getData() - Method in class com.google.api.services.fcm.v1.model.Message

Input only.

getData() - Method in class com.google.api.services.fcm.v1.model.WebpushConfig

Arbitrary key/value payload.

getDefaultLightSettings() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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

getDefaultSound() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

If set to true, use the Android framework's default sound for the notification.

getDefaultVibrateTimings() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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

getDirectBootOk() - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

If set to true, messages will be allowed to be delivered to the app while the device is in
 direct boot mode.

getEventTime() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Set the time that the event in the notification occurred.

getFcmOptions() - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

Options for features provided by the FCM SDK for Android.

getFcmOptions() - Method in class com.google.api.services.fcm.v1.model.ApnsConfig

Options for features provided by the FCM SDK for iOS.

getFcmOptions() - Method in class com.google.api.services.fcm.v1.model.Message

Input only.

getFcmOptions() - Method in class com.google.api.services.fcm.v1.model.WebpushConfig

Options for features provided by the FCM SDK for Web.

getFields() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

Selector specifying which fields to include in a partial response.

getGreen() - Method in class com.google.api.services.fcm.v1.model.Color

The amount of green in the color as a value in the interval [0, 1].

getHeaders() - Method in class com.google.api.services.fcm.v1.model.ApnsConfig

HTTP request headers defined in Apple Push Notification Service.

getHeaders() - Method in class com.google.api.services.fcm.v1.model.WebpushConfig

HTTP headers defined in webpush protocol.

getIcon() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The notification's icon.

getImage() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Contains the URL of an image that is going to be displayed in a notification.

getImage() - Method in class com.google.api.services.fcm.v1.model.ApnsFcmOptions

Contains the URL of an image that is going to be displayed in a notification.

getImage() - Method in class com.google.api.services.fcm.v1.model.Notification

Contains the URL of an image that is going to be downloaded on the device and displayed in a
 notification.

getKey() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

API key.

getLightOffDuration() - Method in class com.google.api.services.fcm.v1.model.LightSettings

Required.

getLightOnDuration() - Method in class com.google.api.services.fcm.v1.model.LightSettings

Required.

getLightSettings() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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

getLink() - Method in class com.google.api.services.fcm.v1.model.WebpushFcmOptions

The link to open when the user clicks on the notification.

getLiveActivityToken() - Method in class com.google.api.services.fcm.v1.model.ApnsConfig

Optional.

getLocalOnly() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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

getMessage() - Method in class com.google.api.services.fcm.v1.model.SendMessageRequest

Required.

getName() - Method in class com.google.api.services.fcm.v1.model.Message

Output Only.

getNotification() - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

Notification to send to android devices.

getNotification() - Method in class com.google.api.services.fcm.v1.model.Message

Input only.

getNotification() - Method in class com.google.api.services.fcm.v1.model.WebpushConfig

Web Notification options as a JSON object.

getNotificationCount() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Sets the number of items this notification represents.

getNotificationPriority() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Set the relative priority for this notification.

getOauthToken() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

OAuth 2.0 token for the current user.

getParent() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send

Required.

getPayload() - Method in class com.google.api.services.fcm.v1.model.ApnsConfig

APNs payload as a JSON object, including both `aps` dictionary and custom payload.

getPrettyPrint() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

Returns response with indentations and line breaks.

getPriority() - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

Message priority.

getProxy() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Setting to control when a notification may be proxied.

getQuotaUser() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

Available to use for quota purposes for server-side applications.

getRed() - Method in class com.google.api.services.fcm.v1.model.Color

The amount of red in the color as a value in the interval [0, 1].

getRestrictedPackageName() - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

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

getSound() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The sound to play when the device receives the notification.

getSticky() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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

getTag() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Identifier used to replace existing notifications in the notification drawer.

getTicker() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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

getTitle() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The notification's title.

getTitle() - Method in class com.google.api.services.fcm.v1.model.Notification

The notification's title.

getTitleLocArgs() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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.

getTitleLocKey() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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.

getToken() - Method in class com.google.api.services.fcm.v1.model.Message

Registration token to send a message to.

getTopic() - Method in class com.google.api.services.fcm.v1.model.Message

Topic name to send a message to, e.g.

getTtl() - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

How long (in seconds) the message should be kept in FCM storage if the device is offline.

getUploadProtocol() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

Upload protocol for media (e.g.

getUploadType() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

Legacy upload protocol for media (e.g.

getValidateOnly() - Method in class com.google.api.services.fcm.v1.model.SendMessageRequest

Flag for testing the request without actually delivering the message.

getVibrateTimings() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Set the vibration pattern to use.

getVisibility() - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Set the [Notification.visibility](https://developer.android.com/reference/android/app/Notificat
 ion.html#visibility) of the notification.

getWebpush() - Method in class com.google.api.services.fcm.v1.model.Message

Input only.





I

initialize(AbstractGoogleClientRequest<?>) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging
 
initializeFirebaseCloudMessagingRequest(FirebaseCloudMessagingRequest<?>) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequestInitializer

Initializes FirebaseCloudMessaging request.

initializeJsonRequest(AbstractGoogleJsonClientRequest<?>) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequestInitializer
 




L

LightSettings - Class in com.google.api.services.fcm.v1.model

Settings to control notification LED.

LightSettings() - Constructor for class com.google.api.services.fcm.v1.model.LightSettings
 




M

Message - Class in com.google.api.services.fcm.v1.model

Message to send by Firebase Cloud Messaging Service.

Message() - Constructor for class com.google.api.services.fcm.v1.model.Message
 
messages() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects

An accessor for creating requests from the Messages collection.

Messages() - Constructor for class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages
 




N

Notification - Class in com.google.api.services.fcm.v1.model

Basic notification template to use across all platforms.

Notification() - Constructor for class com.google.api.services.fcm.v1.model.Notification
 




P

projects() - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging

An accessor for creating requests from the Projects collection.

Projects() - Constructor for class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects
 




S

send(String, SendMessageRequest) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages

Send a message to specified target (a registration token, topic or condition).

Send(String, SendMessageRequest) - Constructor for class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send

Send a message to specified target (a registration token, topic or condition).

SendMessageRequest - Class in com.google.api.services.fcm.v1.model

Request to send a message to specified target.

SendMessageRequest() - Constructor for class com.google.api.services.fcm.v1.model.SendMessageRequest
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.AndroidConfig
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.AndroidFcmOptions
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.ApnsConfig
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.ApnsFcmOptions
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.Color
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.FcmOptions
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.LightSettings
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.Message
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.Notification
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.SendMessageRequest
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.WebpushConfig
 
set(String, Object) - Method in class com.google.api.services.fcm.v1.model.WebpushFcmOptions
 
set$Xgafv(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send
 
set$Xgafv(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

V1 error format.

setAccessToken(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send
 
setAccessToken(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

OAuth access token.

setAlpha(Float) - Method in class com.google.api.services.fcm.v1.model.Color

The fraction of this color that should be applied to the pixel.

setAlt(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send
 
setAlt(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

Data format for response.

setAnalyticsLabel(String) - Method in class com.google.api.services.fcm.v1.model.AndroidFcmOptions

Label associated with the message's analytics data.

setAnalyticsLabel(String) - Method in class com.google.api.services.fcm.v1.model.ApnsFcmOptions

Label associated with the message's analytics data.

setAnalyticsLabel(String) - Method in class com.google.api.services.fcm.v1.model.FcmOptions

Label associated with the message's analytics data.

setAnalyticsLabel(String) - Method in class com.google.api.services.fcm.v1.model.WebpushFcmOptions

Label associated with the message's analytics data.

setAndroid(AndroidConfig) - Method in class com.google.api.services.fcm.v1.model.Message

Input only.

setApns(ApnsConfig) - Method in class com.google.api.services.fcm.v1.model.Message

Input only.

setApplicationName(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder
 
setBatchPath(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder
 
setBlue(Float) - Method in class com.google.api.services.fcm.v1.model.Color

The amount of blue in the color as a value in the interval [0, 1].

setBody(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The notification's body text.

setBody(String) - Method in class com.google.api.services.fcm.v1.model.Notification

The notification's body text.

setBodyLocArgs(List<String>) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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.

setBodyLocKey(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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.

setBypassProxyNotification(Boolean) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

If set, display notifications delivered to the device will be handled by the app instead of the
 proxy.

setCallback(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send
 
setCallback(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

JSONP

setChannelId(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The [notification's channel
 id](https://developer.android.com/guide/topics/ui/notifiers/notifications#ManageChannels) (new
 in Android O).

setClickAction(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The action associated with a user click on the notification.

setCollapseKey(String) - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

An identifier of a group of messages that can be collapsed, so that only the last message gets
 sent when delivery can be resumed.

setColor(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The notification's icon color, expressed in #rrggbb format.

setColor(Color) - Method in class com.google.api.services.fcm.v1.model.LightSettings

Required.

setCondition(String) - Method in class com.google.api.services.fcm.v1.model.Message

Condition to send a message to, e.g.

setData(Map<String, String>) - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

Arbitrary key/value payload.

setData(Map<String, String>) - Method in class com.google.api.services.fcm.v1.model.Message

Input only.

setData(Map<String, String>) - Method in class com.google.api.services.fcm.v1.model.WebpushConfig

Arbitrary key/value payload.

setDefaultLightSettings(Boolean) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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

setDefaultSound(Boolean) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

If set to true, use the Android framework's default sound for the notification.

setDefaultVibrateTimings(Boolean) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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

setDirectBootOk(Boolean) - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

If set to true, messages will be allowed to be delivered to the app while the device is in
 direct boot mode.

setDisableGZipContent(boolean) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest
 
setEventTime(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Set the time that the event in the notification occurred.

setFcmOptions(AndroidFcmOptions) - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

Options for features provided by the FCM SDK for Android.

setFcmOptions(ApnsFcmOptions) - Method in class com.google.api.services.fcm.v1.model.ApnsConfig

Options for features provided by the FCM SDK for iOS.

setFcmOptions(FcmOptions) - Method in class com.google.api.services.fcm.v1.model.Message

Input only.

setFcmOptions(WebpushFcmOptions) - Method in class com.google.api.services.fcm.v1.model.WebpushConfig

Options for features provided by the FCM SDK for Web.

setFields(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send
 
setFields(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

Selector specifying which fields to include in a partial response.

setFirebaseCloudMessagingRequestInitializer(FirebaseCloudMessagingRequestInitializer) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder

Set the FirebaseCloudMessagingRequestInitializer.

setGoogleClientRequestInitializer(GoogleClientRequestInitializer) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder
 
setGreen(Float) - Method in class com.google.api.services.fcm.v1.model.Color

The amount of green in the color as a value in the interval [0, 1].

setHeaders(Map<String, String>) - Method in class com.google.api.services.fcm.v1.model.ApnsConfig

HTTP request headers defined in Apple Push Notification Service.

setHeaders(Map<String, String>) - Method in class com.google.api.services.fcm.v1.model.WebpushConfig

HTTP headers defined in webpush protocol.

setHttpRequestInitializer(HttpRequestInitializer) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder
 
setIcon(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The notification's icon.

setImage(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Contains the URL of an image that is going to be displayed in a notification.

setImage(String) - Method in class com.google.api.services.fcm.v1.model.ApnsFcmOptions

Contains the URL of an image that is going to be displayed in a notification.

setImage(String) - Method in class com.google.api.services.fcm.v1.model.Notification

Contains the URL of an image that is going to be downloaded on the device and displayed in a
 notification.

setKey(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send
 
setKey(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

API key.

setLightOffDuration(String) - Method in class com.google.api.services.fcm.v1.model.LightSettings

Required.

setLightOnDuration(String) - Method in class com.google.api.services.fcm.v1.model.LightSettings

Required.

setLightSettings(LightSettings) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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

setLink(String) - Method in class com.google.api.services.fcm.v1.model.WebpushFcmOptions

The link to open when the user clicks on the notification.

setLiveActivityToken(String) - Method in class com.google.api.services.fcm.v1.model.ApnsConfig

Optional.

setLocalOnly(Boolean) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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

setMessage(Message) - Method in class com.google.api.services.fcm.v1.model.SendMessageRequest

Required.

setName(String) - Method in class com.google.api.services.fcm.v1.model.Message

Output Only.

setNotification(AndroidNotification) - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

Notification to send to android devices.

setNotification(Notification) - Method in class com.google.api.services.fcm.v1.model.Message

Input only.

setNotification(Map<String, Object>) - Method in class com.google.api.services.fcm.v1.model.WebpushConfig

Web Notification options as a JSON object.

setNotificationCount(Integer) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Sets the number of items this notification represents.

setNotificationPriority(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Set the relative priority for this notification.

setOauthToken(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send
 
setOauthToken(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

OAuth 2.0 token for the current user.

setParent(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send

Required.

setPayload(Map<String, Object>) - Method in class com.google.api.services.fcm.v1.model.ApnsConfig

APNs payload as a JSON object, including both `aps` dictionary and custom payload.

setPrettyPrint(Boolean) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send
 
setPrettyPrint(Boolean) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

Returns response with indentations and line breaks.

setPriority(String) - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

Message priority.

setProxy(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Setting to control when a notification may be proxied.

setQuotaUser(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send
 
setQuotaUser(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

Available to use for quota purposes for server-side applications.

setRed(Float) - Method in class com.google.api.services.fcm.v1.model.Color

The amount of red in the color as a value in the interval [0, 1].

setRequestHeaders(HttpHeaders) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest
 
setRestrictedPackageName(String) - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

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

setRootUrl(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder
 
setServicePath(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder
 
setSound(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The sound to play when the device receives the notification.

setSticky(Boolean) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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

setSuppressAllChecks(boolean) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder
 
setSuppressPatternChecks(boolean) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder
 
setSuppressRequiredParameterChecks(boolean) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder
 
setTag(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Identifier used to replace existing notifications in the notification drawer.

setTicker(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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

setTitle(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

The notification's title.

setTitle(String) - Method in class com.google.api.services.fcm.v1.model.Notification

The notification's title.

setTitleLocArgs(List<String>) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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.

setTitleLocKey(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

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.

setToken(String) - Method in class com.google.api.services.fcm.v1.model.Message

Registration token to send a message to.

setTopic(String) - Method in class com.google.api.services.fcm.v1.model.Message

Topic name to send a message to, e.g.

setTtl(String) - Method in class com.google.api.services.fcm.v1.model.AndroidConfig

How long (in seconds) the message should be kept in FCM storage if the device is offline.

setUniverseDomain(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Builder
 
setUploadProtocol(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send
 
setUploadProtocol(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

Upload protocol for media (e.g.

setUploadType(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessaging.Projects.Messages.Send
 
setUploadType(String) - Method in class com.google.api.services.fcm.v1.FirebaseCloudMessagingRequest

Legacy upload protocol for media (e.g.

setValidateOnly(Boolean) - Method in class com.google.api.services.fcm.v1.model.SendMessageRequest

Flag for testing the request without actually delivering the message.

setVibrateTimings(List<String>) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Set the vibration pattern to use.

setVisibility(String) - Method in class com.google.api.services.fcm.v1.model.AndroidNotification

Set the [Notification.visibility](https://developer.android.com/reference/android/app/Notificat
 ion.html#visibility) of the notification.

setWebpush(WebpushConfig) - Method in class com.google.api.services.fcm.v1.model.Message

Input only.





W

WebpushConfig - Class in com.google.api.services.fcm.v1.model

[Webpush protocol](https://tools.ietf.org/html/rfc8030) options.

WebpushConfig() - Constructor for class com.google.api.services.fcm.v1.model.WebpushConfig
 
WebpushFcmOptions - Class in com.google.api.services.fcm.v1.model

Options for features provided by the FCM SDK for Web.

WebpushFcmOptions() - Constructor for class com.google.api.services.fcm.v1.model.WebpushFcmOptions
 

A B C D F G I L M N P S W 




Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev
Next


Frames
No Frames


All Classes








Copyright © 2011–2024 Google. All rights reserved.