let google_fcm = require('@datafire/google_fcm').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

FCM send API that provides a cross-platform messaging solution to reliably deliver messages at no cost.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_fcm.oauthCallback({
  "code": ""
}, context)

Input

input object
- code required string

Output

output object
- access_token string
- refresh_token string
- token_type string
- scope string
- expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_fcm.oauthRefresh(null, context)

Input

This action has no parameters

Output

output object
- access_token string
- refresh_token string
- token_type string
- scope string
- expiration string

fcm.projects.messages.send

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

google_fcm.fcm.projects.messages.send({
  "parent": ""
}, context)

Input

input object
- parent required string: Required. It contains the Firebase project id (i.e. the unique identifier for your Firebase project), in the format of projects/{project_id}. For legacy support, the numeric project number with no padding is also supported in the format of projects/{project_number}.
- body SendMessageRequest
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Message

Definitions

AndroidConfig

AndroidConfig object: Android specific options for messages sent through FCM connection server.
- collapseKey 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.
- data object: Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data.
- directBootOk boolean: 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.
- fcmOptions AndroidFcmOptions
- notification AndroidNotification
- priority string (values: NORMAL, HIGH): Message priority. Can take "normal" and "high" values. For more information, see Setting the priority of a message.
- restrictedPackageName 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. 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.

AndroidFcmOptions

AndroidFcmOptions object: Options for features provided by the FCM SDK for Android.
- analyticsLabel string: Label associated with the message's analytics data.

AndroidNotification

AndroidNotification object: Notification to send to android devices.
- body string: The notification's body text. If present, it will override google.firebase.fcm.v1.Notification.body.
- bodyLocArgs array: 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. See Formatting and Styling for more information.
  - items string
- bodyLocKey string: 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. See String Resources for more information.
- channelId string: The notification's channel id (new in Android O). The app must create a channel with this channel ID before any notification with this channel ID is received. If you don't send this channel ID in the request, or if the channel ID provided has not yet been created by the app, FCM uses the channel ID specified in the app manifest.
- clickAction string: The action associated with a user click on the notification. If specified, an activity with a matching intent filter is launched when a user clicks on the notification.
- color string: The notification's icon color, expressed in #rrggbb format.
- defaultLightSettings boolean: 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.
- defaultSound boolean: If set to true, use the Android framework's default sound for the notification. Default values are specified in config.xml.
- defaultVibrateTimings boolean: 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.
- eventTime string: Set the time that the event in the notification occurred. Notifications in the panel are sorted by this time. A point in time is represented using protobuf.Timestamp.
- icon string: The notification's icon. Sets the notification icon to myicon for drawable resource myicon. If you don't send this key in the request, FCM displays the launcher icon specified in your app manifest.
- image string: Contains the URL of an image that is going to be displayed in a notification. If present, it will override google.firebase.fcm.v1.Notification.image.
- lightSettings LightSettings
- localOnly boolean: Set whether or not this notification is relevant only to the current device. Some notifications can be bridged to other devices for remote display, such as a Wear OS watch. This hint can be set to recommend this notification not be bridged. See Wear OS guides
- notificationCount integer: Sets the number of items this notification represents. May be displayed as a badge count for launchers that support badging.See Notification Badge. 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.
- notificationPriority string (values: PRIORITY_UNSPECIFIED, PRIORITY_MIN, PRIORITY_LOW, PRIORITY_DEFAULT, PRIORITY_HIGH, PRIORITY_MAX): Set the relative priority for this notification. Priority is an indication of how much of the user's attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. The effect of setting the same priorities may differ slightly on different platforms. Note this priority differs from AndroidMessagePriority. This priority is processed by the client after the message has been delivered, whereas AndroidMessagePriority is an FCM concept that controls when the message is delivered.
- sound string: The sound to play when the device receives the notification. Supports "default" or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/.
- sticky boolean: When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel. When set to true, the notification persists even when the user clicks it.
- tag string: Identifier used to replace existing notifications in the notification drawer. If not specified, each request creates a new notification. If specified and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer.
- ticker string: Sets the "ticker" text, which is sent to accessibility services. Prior to API level 21 (Lollipop), sets the text that is displayed in the status bar when the notification first arrives.
- title string: The notification's title. If present, it will override google.firebase.fcm.v1.Notification.title.
- titleLocArgs array: 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. See Formatting and Styling for more information.
  - items string
- titleLocKey string: 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. See String Resources for more information.
- vibrateTimings array: Set the vibration pattern to use. Pass in an array of protobuf.Duration to turn on or off the vibrator. The first value indicates the Duration to wait before turning the vibrator on. The next value indicates the Duration to keep the vibrator on. Subsequent values alternate between Duration to turn the vibrator off and to turn the vibrator on. If vibrate_timings is set and default_vibrate_timings is set to true, the default value is used instead of the user-specified vibrate_timings.
  - items string
- visibility string (values: VISIBILITY_UNSPECIFIED, PRIVATE, PUBLIC, SECRET): Set the Notification.visibility of the notification.

ApnsConfig

ApnsConfig object: Apple Push Notification Service specific options.
- fcmOptions ApnsFcmOptions
- headers object: HTTP request headers defined in Apple Push Notification Service. Refer to APNs request headers for supported headers, e.g. "apns-priority": "10".
- payload object: APNs payload as a JSON object, including both aps dictionary and custom payload. See Payload Key Reference. If present, it overrides google.firebase.fcm.v1.Notification.title and google.firebase.fcm.v1.Notification.body.

ApnsFcmOptions

ApnsFcmOptions object: Options for features provided by the FCM SDK for iOS.
- analyticsLabel string: Label associated with the message's analytics data.
- image string: Contains the URL of an image that is going to be displayed in a notification. If present, it will override google.firebase.fcm.v1.Notification.image.

Color

Color object: Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...
- alpha number: The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).
- blue number: The amount of blue in the color as a value in the interval [0, 1].
- green number: The amount of green in the color as a value in the interval [0, 1].
- red number: The amount of red in the color as a value in the interval [0, 1].

FcmOptions

FcmOptions object: Platform independent options for features provided by the FCM SDKs.
- analyticsLabel string: Label associated with the message's analytics data.

LightSettings

LightSettings object: Settings to control notification LED.
- color Color
- lightOffDuration string: Required. Along with light_on_duration , define the blink rate of LED flashes. Resolution defined by proto.Duration
- lightOnDuration string: Required. Along with light_off_duration, define the blink rate of LED flashes. Resolution defined by proto.Duration

Message

Message object: Message to send by Firebase Cloud Messaging Service.
- android AndroidConfig
- apns ApnsConfig
- condition string: Condition to send a message to, e.g. "'foo' in topics && 'bar' in topics".
- data object: Input only. Arbitrary key/value payload. The key should not be a reserved word ("from", "message_type", or any word starting with "google" or "gcm").
- fcmOptions FcmOptions
- name string: Output Only. The identifier of the message sent, in the format of projects/*/messages/{message_id}.
- notification Notification
- token string: Registration token to send a message to.
- topic string: Topic name to send a message to, e.g. "weather". Note: "/topics/" prefix should not be provided.
- webpush WebpushConfig

Notification

Notification object: Basic notification template to use across all platforms.
- body string: The notification's body text.
- image string: Contains the URL of an image that is going to be downloaded on the device and displayed in a notification. JPEG, PNG, BMP have full support across platforms. Animated GIF and video only work on iOS. WebP and HEIF have varying levels of support across platforms and platform versions. Android has 1MB image size limit. Quota usage and implications/costs for hosting image on Firebase Storage: https://firebase.google.com/pricing
- title string: The notification's title.

SendMessageRequest

SendMessageRequest object: Request to send a message to specified target.
- message Message
- validateOnly boolean: Flag for testing the request without actually delivering the message.

WebpushConfig

WebpushConfig object: Webpush protocol options.
- data object: Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data.
- fcmOptions WebpushFcmOptions
- headers object: HTTP headers defined in webpush protocol. Refer to Webpush protocol for supported headers, e.g. "TTL": "15".
- notification object: Web Notification options as a JSON object. Supports Notification instance properties as defined in Web Notification API. If present, "title" and "body" fields override [google.firebase.fcm.v1.Notification.title] and [google.firebase.fcm.v1.Notification.body].

WebpushFcmOptions

WebpushFcmOptions object: Options for features provided by the FCM SDK for Web.
- analyticsLabel string: Label associated with the message's analytics data.
- link string: The link to open when the user clicks on the notification. For all URL values, HTTPS is required.

FAQs

What is @datafire/google_fcm?

Is @datafire/google_fcm popular?

Is @datafire/google_fcm well maintained?

Last updated on 21 Dec 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@datafire/google_fcm