53 lines
2.3 KiB
TypeScript
53 lines
2.3 KiB
TypeScript
|
/*! firebase-admin v11.0.1 */
|
||
|
|
/*!
|
||
|
|
* Copyright 2020 Google Inc.
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* Firebase Cloud Messaging (FCM).
|
||
|
|
*
|
||
|
|
* @packageDocumentation
|
||
|
|
*/
|
||
|
|
import { App } from '../app';
|
||
|
|
import { Messaging } from './messaging';
|
||
|
|
export { Messaging, } from './messaging';
|
||
|
|
export { AndroidConfig, AndroidFcmOptions, AndroidNotification, ApnsConfig, ApnsFcmOptions, ApnsPayload, Aps, ApsAlert, BaseMessage, BatchResponse, CriticalSound, ConditionMessage, FcmOptions, LightSettings, Message, MessagingTopicManagementResponse, MulticastMessage, Notification, SendResponse, TokenMessage, TopicMessage, WebpushConfig, WebpushFcmOptions, WebpushNotification, DataMessagePayload, MessagingConditionResponse, MessagingDeviceGroupResponse, MessagingDeviceResult, MessagingDevicesResponse, MessagingOptions, MessagingPayload, MessagingTopicResponse, NotificationMessagePayload, } from './messaging-api';
|
||
|
|
/**
|
||
|
|
* Gets the {@link Messaging} service for the default app or a given app.
|
||
|
|
*
|
||
|
|
* `admin.messaging()` can be called with no arguments to access the default
|
||
|
|
* app's `Messaging` service or as `admin.messaging(app)` to access the
|
||
|
|
* `Messaging` service associated with aspecific app.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* ```javascript
|
||
|
|
* // Get the Messaging service for the default app
|
||
|
|
* const defaultMessaging = getMessaging();
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* ```javascript
|
||
|
|
* // Get the Messaging service for a given app
|
||
|
|
* const otherMessaging = getMessaging(otherApp);
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @param app - Optional app whose `Messaging` service to
|
||
|
|
* return. If not provided, the default `Messaging` service will be returned.
|
||
|
|
*
|
||
|
|
* @returns The default `Messaging` service if no
|
||
|
|
* app is provided or the `Messaging` service associated with the provided
|
||
|
|
* app.
|
||
|
|
*/
|
||
|
|
export declare function getMessaging(app?: App): Messaging;
|