API reference: pyric-admin/messaging

Classes

FirebaseMessagingError

Extends

Error

Constructors

Constructor

new FirebaseMessagingError(info: ErrorCodeInfo, message?: string): FirebaseMessagingError;

Parameters

Parameter	Type
`info`	`ErrorCodeInfo`
`message?`	`string`

Returns

FirebaseMessagingError

Overrides

Error.constructor

Properties

Property	Modifier	Type
`code`	`readonly`	`string`

Messaging

The sandbox Messaging service mirror, implementing the send plane over the broker.

Constructors

Constructor

new Messaging(app: SandboxAdminApp): Messaging;

Parameters

Parameter	Type
`app`	`SandboxAdminApp`

Returns

Messaging

Accessors

app

Get Signature

get app(): SandboxAdminApp;

The app this Messaging instance is bound to (upstream get app(): App).

Returns

SandboxAdminApp

Methods

enableLegacyHttpTransport()

enableLegacyHttpTransport(): void;

Force HTTP/1.1 for batch sends — deprecated upstream; the sandbox has no HTTP transport, so this is a recorded no-op.

Returns

void

send()

send(message: Message, dryRun?: boolean): Promise<string>;

Send one message. Resolves the FCM resource name projects/<projectId>/messages/<id> — numeric id for topic/condition targets, UUID-form for token targets. dryRun validates on the identical path and returns the SAME shape with a fake id (captured dryRunSameShapeAsReal / realSendEnvelopeIdentical parity).

Parameters

Parameter	Type
`message`	`Message`
`dryRun?`	`boolean`

Returns

Promise<string>

sendEach()

sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Send up to 500 messages; the resolved BatchResponse.responses array is ordered to match the input, one entry per message.

Parameters

Parameter	Type
`messages`	`Message`[]
`dryRun?`	`boolean`

Returns

Promise<BatchResponse>

sendEachForMulticast()

sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Fan a MulticastMessage (up to 500 tokens) out through sendEach.

Parameters

Parameter	Type
`message`	`MulticastMessage`
`dryRun?`	`boolean`

Returns

Promise<BatchResponse>

subscribeToTopic()

subscribeToTopic(tokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Subscribe one or many registration tokens to a topic.

Parameters

Parameter	Type
`tokenOrTokens`	`string` \| `string`[]
`topic`	`string`

Returns

Promise<MessagingTopicManagementResponse>

unsubscribeFromTopic()

unsubscribeFromTopic(tokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Unsubscribe one or many registration tokens from a topic.

Parameters

Parameter	Type
`tokenOrTokens`	`string` \| `string`[]
`topic`	`string`

Returns

Promise<MessagingTopicManagementResponse>

MessagingClientErrorCode

Constructors

Constructor

new MessagingClientErrorCode(): MessagingClientErrorCode;

Returns

MessagingClientErrorCode

Properties

Property	Modifier	Type
`INVALID_ARGUMENT`	`readonly`	{ `code`: `string`; `message`: `string`; }
`INVALID_ARGUMENT.code`	`public`	`string`
`INVALID_ARGUMENT.message`	`public`	`string`
`INVALID_REGISTRATION_TOKEN`	`readonly`	{ `code`: `string`; `message`: `string`; }
`INVALID_REGISTRATION_TOKEN.code`	`public`	`string`
`INVALID_REGISTRATION_TOKEN.message`	`public`	`string`
`REGISTRATION_TOKEN_NOT_REGISTERED`	`readonly`	{ `code`: `string`; `message`: `string`; }
`REGISTRATION_TOKEN_NOT_REGISTERED.code`	`public`	`string`
`REGISTRATION_TOKEN_NOT_REGISTERED.message`	`public`	`string`

Interfaces

BaseMessage

Extends

Omit<BrokerMessage, "token" | "topic" | "condition">

Properties

Property	Type
`android?`	`Record`<`string`, `unknown`>
`apns?`	`Record`<`string`, `unknown`>
`data?`	`Record`<`string`, `string`>
`fcmOptions?`	{ `analyticsLabel?`: `string`; }
`fcmOptions.analyticsLabel?`	`string`
`notification?`	{ `body?`: `string`; `imageUrl?`: `string`; `title?`: `string`; }
`notification.body?`	`string`
`notification.imageUrl?`	`string`
`notification.title?`	`string`
`webpush?`	{ `data?`: `Record`<`string`, `string`>; `fcmOptions?`: { `link?`: `string`; }; `headers?`: `Record`<`string`, `string`>; `notification?`: `Record`<`string`, `unknown`>; }
`webpush.data?`	`Record`<`string`, `string`>
`webpush.fcmOptions?`	{ `link?`: `string`; }
`webpush.fcmOptions.link?`	`string`
`webpush.headers?`	`Record`<`string`, `string`>
`webpush.notification?`	`Record`<`string`, `unknown`>

BatchResponse

Properties

Property	Type
`failureCount`	`number`
`responses`	`SendResponse`[]
`successCount`	`number`

ConditionMessage

Extends

BaseMessage

Properties

Property	Type
`android?`	`Record`<`string`, `unknown`>
`apns?`	`Record`<`string`, `unknown`>
`condition`	`string`
`data?`	`Record`<`string`, `string`>
`fcmOptions?`	{ `analyticsLabel?`: `string`; }
`fcmOptions.analyticsLabel?`	`string`
`notification?`	{ `body?`: `string`; `imageUrl?`: `string`; `title?`: `string`; }
`notification.body?`	`string`
`notification.imageUrl?`	`string`
`notification.title?`	`string`
`webpush?`	{ `data?`: `Record`<`string`, `string`>; `fcmOptions?`: { `link?`: `string`; }; `headers?`: `Record`<`string`, `string`>; `notification?`: `Record`<`string`, `unknown`>; }
`webpush.data?`	`Record`<`string`, `string`>
`webpush.fcmOptions?`	{ `link?`: `string`; }
`webpush.fcmOptions.link?`	`string`
`webpush.headers?`	`Record`<`string`, `string`>
`webpush.notification?`	`Record`<`string`, `unknown`>

MessagingTopicManagementResponse

Properties

Property	Type
`errors`	{ `error`: `FirebaseMessagingError`; `index`: `number`; }[]
`failureCount`	`number`
`successCount`	`number`

MulticastMessage

Extends

BaseMessage

Properties

Property	Type
`android?`	`Record`<`string`, `unknown`>
`apns?`	`Record`<`string`, `unknown`>
`data?`	`Record`<`string`, `string`>
`fcmOptions?`	{ `analyticsLabel?`: `string`; }
`fcmOptions.analyticsLabel?`	`string`
`notification?`	{ `body?`: `string`; `imageUrl?`: `string`; `title?`: `string`; }
`notification.body?`	`string`
`notification.imageUrl?`	`string`
`notification.title?`	`string`
`tokens`	`string`[]
`webpush?`	{ `data?`: `Record`<`string`, `string`>; `fcmOptions?`: { `link?`: `string`; }; `headers?`: `Record`<`string`, `string`>; `notification?`: `Record`<`string`, `unknown`>; }
`webpush.data?`	`Record`<`string`, `string`>
`webpush.fcmOptions?`	{ `link?`: `string`; }
`webpush.fcmOptions.link?`	`string`
`webpush.headers?`	`Record`<`string`, `string`>
`webpush.notification?`	`Record`<`string`, `unknown`>

SendResponse

Properties

Property	Type
`error?`	`FirebaseMessagingError`
`messageId?`	`string`
`success`	`boolean`

TokenMessage

Extends

BaseMessage

Properties

Property	Type
`android?`	`Record`<`string`, `unknown`>
`apns?`	`Record`<`string`, `unknown`>
`data?`	`Record`<`string`, `string`>
`fcmOptions?`	{ `analyticsLabel?`: `string`; }
`fcmOptions.analyticsLabel?`	`string`
`notification?`	{ `body?`: `string`; `imageUrl?`: `string`; `title?`: `string`; }
`notification.body?`	`string`
`notification.imageUrl?`	`string`
`notification.title?`	`string`
`token`	`string`
`webpush?`	{ `data?`: `Record`<`string`, `string`>; `fcmOptions?`: { `link?`: `string`; }; `headers?`: `Record`<`string`, `string`>; `notification?`: `Record`<`string`, `unknown`>; }
`webpush.data?`	`Record`<`string`, `string`>
`webpush.fcmOptions?`	{ `link?`: `string`; }
`webpush.fcmOptions.link?`	`string`
`webpush.headers?`	`Record`<`string`, `string`>
`webpush.notification?`	`Record`<`string`, `unknown`>

TopicMessage

Extends

BaseMessage

Properties

Property	Type
`android?`	`Record`<`string`, `unknown`>
`apns?`	`Record`<`string`, `unknown`>
`data?`	`Record`<`string`, `string`>
`fcmOptions?`	{ `analyticsLabel?`: `string`; }
`fcmOptions.analyticsLabel?`	`string`
`notification?`	{ `body?`: `string`; `imageUrl?`: `string`; `title?`: `string`; }
`notification.body?`	`string`
`notification.imageUrl?`	`string`
`notification.title?`	`string`
`topic`	`string`
`webpush?`	{ `data?`: `Record`<`string`, `string`>; `fcmOptions?`: { `link?`: `string`; }; `headers?`: `Record`<`string`, `string`>; `notification?`: `Record`<`string`, `unknown`>; }
`webpush.data?`	`Record`<`string`, `string`>
`webpush.fcmOptions?`	{ `link?`: `string`; }
`webpush.fcmOptions.link?`	`string`
`webpush.headers?`	`Record`<`string`, `string`>
`webpush.notification?`	`Record`<`string`, `unknown`>

Type Aliases

AndroidConfig

type AndroidConfig = Record<string, unknown>;

AndroidFcmOptions

type AndroidFcmOptions = Record<string, unknown>;

AndroidNotification

type AndroidNotification = Record<string, unknown>;

ApnsConfig

type ApnsConfig = Record<string, unknown>;

ApnsFcmOptions

type ApnsFcmOptions = Record<string, unknown>;

ApnsPayload

type ApnsPayload = Record<string, unknown>;

Aps

type Aps = Record<string, unknown>;

ApsAlert

type ApsAlert = string | Record<string, unknown>;

CriticalSound

type CriticalSound = Record<string, unknown>;

DataMessagePayload

type DataMessagePayload = Record<string, string>;

FcmOptions

type FcmOptions = NonNullable<BrokerMessage["fcmOptions"]>;

LightSettings

type LightSettings = Record<string, unknown>;

Message

type Message =
  | TokenMessage
  | TopicMessage
  | ConditionMessage;

MessagingOptions

type MessagingOptions = Record<string, unknown>;

MessagingPayload

type MessagingPayload = Record<string, unknown>;

Notification

type Notification = NonNullable<BrokerMessage["notification"]>;

Mirror-owned structural messaging types.

NotificationMessagePayload

type NotificationMessagePayload = Record<string, string>;

WebpushConfig

type WebpushConfig = NonNullable<BrokerMessage["webpush"]>;

WebpushFcmOptions

type WebpushFcmOptions = NonNullable<WebpushConfig["fcmOptions"]>;

WebpushNotification

type WebpushNotification = Record<string, unknown>;

Functions

getMessaging()

function getMessaging(app?: SandboxAdminApp): Messaging;

Return the broker-backed Messaging service for the default or given sandbox admin app.

Parameters

Parameter	Type
`app?`	`SandboxAdminApp`

Returns

Messaging

messaging()

function messaging(app?: SandboxAdminApp): Messaging;

Namespaced / legacy accessor — the admin.messaging(app?) equivalent of getMessaging.

Parameters

Parameter	Type
`app?`	`SandboxAdminApp`

Returns

Messaging