Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

GCMMessage

import type { GCMMessage } from "https://aws-api.deno.dev/v0.4/services/pinpoint.ts?docs=full";

Specifies the settings for a one-time message that's sent directly to an endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint to send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

interface GCMMessage {

Action?: Action | null;

Body?: string | null;

CollapseKey?: string | null;

Data?: {

[key: string]: string | null | undefined;

} | null;

IconReference?: string | null;

ImageIconUrl?: string | null;

ImageUrl?: string | null;

Priority?: string | null;

RawContent?: string | null;

RestrictedPackageName?: string | null;

SilentPush?: boolean | null;

SmallImageIconUrl?: string | null;

Sound?: string | null;

Substitutions?: {

[key: string]: string[] | null | undefined;

} | null;

TimeToLive?: number | null;

Title?: string | null;

Url?: string | null;

}

§Properties

Action?: Action | null

The action to occur if the recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

Body?: string | null

The body of the notification message.

CollapseKey?: string | null

An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.

Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.

Data?: {

[key: string]: string | null | undefined;

} | null

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

IconReference?: string | null

The icon image name of the asset saved in your app.

ImageIconUrl?: string | null

The URL of the large icon image to display in the content view of the push notification.

ImageUrl?: string | null

The URL of an image to display in the push notification.

Priority?: string | null

TODO: Failed to render documentation: unhandled top level doc tag li

RawContent?: string | null

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

RestrictedPackageName?: string | null

The package name of the application where registration tokens must match in order for the recipient to receive the message.

SilentPush?: boolean | null

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

SmallImageIconUrl?: string | null

The URL of the small icon image to display in the status bar and the content view of the push notification.

Sound?: string | null

The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

Substitutions?: {

[key: string]: string[] | null | undefined;

} | null

The default message variables to use in the notification message. You can override the default variables with individual address variables.

TimeToLive?: number | null

The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.

Title?: string | null

The title to display above the notification message on the recipient's device.

Url?: string | null

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.