@azure/notification-hubs package

类

NotificationHubsClient

这表示 Azure 通知中心的客户端，用于管理安装和向设备发送消息。

接口

AdmInstallation	表示基于 Amazon Device Messaging （ADM） 的安装。
AdmNativeMessage	表示本机 ADM 通知消息有效负载。
AdmNativeNotification	描述 ADM 通知消息。
AdmNotification	表示 Amazon Device Messaging （ADM） 推送通知。
AdmNotificationParams	表示可以发送到设备的 ADM 通知。
AdmRegistrationChannel	描述 ADM 注册通道查询。
AdmRegistrationDescription	表示 Amazon Device Messaging （ADM） 注册的说明。
AdmRegistrationDescriptionCommon	表示注册说明。
AdmTemplateRegistrationDescription	表示 Amazon Device Messaging （ADM） 模板注册的说明。
AdmTemplateRegistrationDescriptionCommon	表示 Amazon Device Messaging （ADM） 模板注册的说明。
AppleAlert	表示 APNs 警报正文中的内容。
AppleApsNativeMessage	表示本机 APNs APS 消息。
AppleCriticalSound	表示 APNs 关键声音
AppleHeaders	特定于 APN 的标头列表。
AppleInstallation	表示基于 Apple APN 的安装。
AppleNativeMessage	表示本机 APN 消息。
AppleNotification	表示 Apple APN 推送通知。
AppleNotificationParams	表示可发送到设备的 Apple 通知。
AppleRegistrationChannel	描述 Apple 注册通道查询。
AppleRegistrationDescription	表示 apple 注册的说明。
AppleRegistrationDescriptionCommon	表示 apple 注册的说明。
AppleTemplateRegistrationDescription	表示 Apple 模板注册的说明。
AppleTemplateRegistrationDescriptionCommon	表示 Apple 模板注册的说明。
BaiduAppleNativePayload	表示百度 Apple 本机有效负载。
BaiduInstallation	表示基于百度安装的安装。
BaiduNativeMessage	百度本机格式：https://stackoverflow.com/questions/42591815/customize-baidu-push-json-payloadhttp://www.tuicool.com/articles/ZnmANn
BaiduNotification	表示百度推送通知。
BaiduRegistrationChannel	介绍百度注册通道查询。
BaiduRegistrationDescription	表示百度注册说明。
BaiduRegistrationDescriptionCommon	表示注册说明。
BaiduTemplateRegistrationDescription	表示百度模板注册说明。
BaiduTemplateRegistrationDescriptionCommon	表示百度模板注册说明。
BroadcastSendNotificationOptions	用于发送测试发送通知的选项。
BrowserInstallation	表示基于浏览器/Web 推送的安装。
BrowserInstallationCommon	表示基于浏览器/Web 推送的安装。
BrowserNotification	表示浏览器推送通知。
BrowserPushChannel	表示浏览器推送安装的推送通道。
BrowserRegistrationChannel	描述浏览器注册通道查询。
BrowserRegistrationDescription	表示浏览器推送注册说明。
BrowserRegistrationDescriptionCommon	表示浏览器推送注册说明。
BrowserTemplateRegistrationDescription	表示浏览器推送重板注册说明。
BrowserTemplateRegistrationDescriptionCommon	表示浏览器推送重板注册说明。
DeviceTokenInstallation	表示具有基于字符串的设备令牌的安装。
DirectSendNotificationOptions	用于向单个设备发送通知的选项。
EntityOperationOptions	表示可以设置的实体更新操作选项。
FcmLegacyInstallation	表示 Firebase 旧版 HTTP 安装。
FcmLegacyNotification	表示 Firebase 旧版 HTTP 推送通知。
FcmLegacyNotificationParams	表示可以发送到设备的 Firebase 旧版通知。
FcmV1Installation	表示基于 Firebase V1 Cloud Messaging 的安装。
FcmV1Notification	表示可以发送到设备的 Firebase V1 API 通知。
FcmV1NotificationParams	表示可以发送到设备的 Firebase V1 通知。
FcmV1RegistrationDescription	表示 Google Cloud Messaging 的通知中心注册说明。
FcmV1RegistrationDescriptionCommon	表示 Google Cloud Messaging 的通知中心注册说明。
FcmV1TemplateRegistrationDescription	表示 Firebase V1 Cloud Messaging 的通知中心模板注册说明。
FcmV1TemplateRegistrationDescriptionCommon	表示 Firebase V1 Cloud Messaging 的通知中心模板注册说明。
FirebaseLegacyAndroidNativePayload	表示 Firebase 旧版 HTTP 接口的 Android 本机有效负载。
FirebaseLegacyAppleNativePayload	表示 Firebase 旧版 HTTP 接口的 APN 本机有效负载。
FirebaseLegacyNativeMessage	表示 Firebase 旧版 HTTP 接口的 HTTP JSON 消息的目标、选项和有效负载。
FirebaseLegacyRegistrationChannel	介绍 Firebase 旧版注册通道查询。
FirebaseLegacyWebNativePayload	表示 Firebase 旧版 HTTP 接口的 Web 推送本机有效负载。
FirebaseV1AndroidConfig	通过 FCM 连接服务器发送的消息的 Android 特定选项。
FirebaseV1AndroidFcmOptions	适用于 Android 的 FCM SDK 提供的功能选项。
FirebaseV1AndroidNotification	发送到 android 设备的通知。
FirebaseV1ApnsConfig	Apple 推送通知服务特定选项。
FirebaseV1ApnsFcmOptions	适用于 iOS 的 FCM SDK 提供的功能选项。
FirebaseV1FcmOptions
FirebaseV1NativeMessage	表示 Firebase V1 接口的 HTTP JSON 消息的目标、选项和有效负载。
FirebaseV1NativeMessageEnvelope	表示 Firebase V1 本机消息信封。
FirebaseV1NativeNotification	表示本机 FCM V1 通知消息有效负载。
FirebaseV1RegistrationChannel	介绍 Firebase 旧版注册通道查询。
FirebaseV1WebPushConfig
FirebaseV1WebPushFcmOptions	FCM SDK for Web 提供的功能选项。
FirebaseV1WebPushNotification	表示 Web 推送通知有效负载。
GcmRegistrationDescription	表示 Google Cloud Messaging 的通知中心注册说明。
GcmRegistrationDescriptionCommon	表示 Google Cloud Messaging 的通知中心注册说明。
GcmTemplateRegistrationDescription	表示 Firebase 旧版云消息传送的通知中心模板注册说明。
GcmTemplateRegistrationDescriptionCommon	表示 Firebase 旧版云消息传送的通知中心模板注册说明。
InstallationCommon	表示通知中心的设备的安装。
InstallationTemplate	表示安装模板。
JsonNotification	表示 JSON 通知中心。
JsonPatch	表示修补操作。
MpnsRegistrationDescription	表示 Windows Phone 通知服务注册说明。
MpnsRegistrationDescriptionCommon	表示 Windows Phone 通知服务注册说明。
MpnsTemplateRegistrationDescription	表示 Windows Phone 通知服务模板注册。
MpnsTemplateRegistrationDescriptionCommon	表示 Windows Phone 通知服务模板注册。
NotificationCommon	表示可以发送到设备的通知。
NotificationCommonParams	接受字符串正文或 JSON 正文的常见通知参数。
NotificationDetails	表示通知详细信息。
NotificationHubJob	表示通知中心作业。
NotificationHubsClientOptions	描述创建 NotificationHubsClientContext 时可以提供的选项。
NotificationHubsMessageResponse	描述来自通知中心服务的响应，以便执行发送操作。
NotificationHubsResponse	描述来自通知中心的响应，其中包括跟踪 ID、关联 ID 和位置。
NotificationOutcome	每个状态的每个平台计数。
PolledOperationOptions	轮询操作的选项，包括轮询间隔周期。
RegistrationDescriptionCommon	表示注册说明。
RegistrationQueryLimitOptions	表示包含$top支持的查询选项。
RegistrationQueryOptions	表示包含$top和$filter的查询选项。
RegistrationQueryResponse	描述使用注册和延续令牌的注册查询响应。
RegistrationResult	表示注册的结果。
ScheduleNotificationOptions	用于发送两个基于标记的计划发送通知的选项。
SendNotificationOptions	用于发送基于标记的发送通知的选项。
TemplateNotification	表示基于模板的推送通知。
TemplateRegistrationDescription	表示模板注册的说明。
WindowsBadgeNativeMessage	表示 Windows 锁屏提醒消息
WindowsHeaders	WNS 特定标头的列表。
WindowsInstallation	表示基于 Windows 通知服务（WNS）的安装。
WindowsNotification	表示 Windows 通知服务（WNS）推送通知。
WindowsRegistrationChannel	介绍 Windows 通知服务注册通道查询。
WindowsRegistrationDescription	表示 Windows 通知服务（WNS）注册说明。
WindowsRegistrationDescriptionCommon	表示 Windows 通知服务（WNS）注册说明。
WindowsTemplateRegistrationDescription	表示 Windows 通知服务 （WNS） 模板注册。
WindowsTemplateRegistrationDescriptionCommon	表示 Windows 通知服务 （WNS） 模板注册。
WnsNotificationParams	表示可以发送到设备的 WNS 通知。
XiaomiInstallation	表示基于小米的安装。
XiaomiNotification	表示小米推送通知。
XiaomiRegistrationChannel	介绍小米注册通道查询。
XiaomiRegistrationDescription	表示小米注册说明。
XiaomiRegistrationDescriptionCommon	表示小米注册说明。
XiaomiTemplateRegistrationDescription	表示 Windows 通知服务 （WNS） 模板注册。
XiaomiTemplateRegistrationDescriptionCommon	表示小米模板注册。

类型别名

ApnsPushTypes	描述 APN 推送的类型。
Installation	表示通知中心中可用的安装类型。
JsonPatchOperation	表示添加、删除和替换的 JSON 修补程序类型。
Notification	表示可能的推送通知消息类型。
NotificationHubJobPoller	描述 NotificationHubJob 类型的轮询器。
NotificationHubJobStatus	描述通知中心作业状态的类型。
NotificationHubJobType	描述通知中心作业的类型。
NotificationOutcomeState	表示通知结果状态。
PushHandle	表示可用于通知中心的推送通道的类型。
RegistrationChannel	描述注册查询。
RegistrationDescription	描述注册说明的类型。
RegistrationType	表示注册说明的类型。
WindowsBadgeGlyphType	表示 Windows 锁屏提醒标志符号的类型
WindowsContentType	表示可能的 WNS 内容类型。
WnsTypes	WNS 特定类型的列表。

函数

createAdmInstallation(DeviceTokenInstallation)	创建基于 Amazon Device Messaging （ADM） 的安装。
createAdmNotification(AdmNotificationParams)	创建要发送到 Amazon Device Messaging 设备的通知。
createAdmNotificationBody(AdmNativeMessage)	从本机 ADM 有效负载创建 AdmNotification。
createAdmRegistrationDescription(AdmRegistrationDescriptionCommon)	创建 ADM 注册说明。
createAdmTemplateRegistrationDescription(AdmTemplateRegistrationDescriptionCommon)	创建 ADM 模板注册说明。
createAppleInstallation(DeviceTokenInstallation)	创建基于 Apple 的安装。
createAppleNotification(AppleNotificationParams)	创建要发送到 Apple 设备的通知。
createAppleNotificationBody(AppleNativeMessage)	创建要发送到通知中心的 APN 本机消息。
createAppleRegistrationDescription(AppleRegistrationDescriptionCommon)	创建 Apple 注册说明。
createAppleTemplateRegistrationDescription(AppleTemplateRegistrationDescriptionCommon)	创建 Apple 模板注册说明。
createBaiduInstallation(DeviceTokenInstallation)	创建基于百度安装的安装。
createBaiduNotification(NotificationCommonParams)	创建要发送到百度注册设备的通知。
createBaiduNotificationBody(BaiduNativeMessage)	从本机百度有效负载创建百度Notification。
createBaiduRegistrationDescription(BaiduRegistrationDescriptionCommon)	创建百度注册说明。
createBaiduTemplateRegistrationDescription(BaiduTemplateRegistrationDescriptionCommon)	创建百度模板注册说明。
createBrowserInstallation(BrowserInstallationCommon)	创建基于 Web 推送的安装。
createBrowserNotification(NotificationCommonParams)	创建要发送到浏览器的通知。
createBrowserRegistrationDescription(BrowserRegistrationDescriptionCommon)	创建 Web 推送注册说明。
createBrowserTemplateRegistrationDescription(BrowserTemplateRegistrationDescriptionCommon)	创建 Web 推送注册说明。
createFcmLegacyInstallation(DeviceTokenInstallation)	创建基于 Firebase 旧版 HTTP 的安装。
createFcmLegacyNotification(FcmLegacyNotificationParams)	创建要发送到 Firebase 的通知。
createFcmLegacyRegistrationDescription(GcmRegistrationDescriptionCommon)	创建 Firebase 旧版注册说明。
createFcmLegacyTemplateRegistrationDescription(GcmTemplateRegistrationDescriptionCommon)	创建 GCM 模板注册说明。
createFcmV1Installation(DeviceTokenInstallation)	创建基于 Firebase V1 Cloud Messaging 的安装。
createFcmV1Notification(FcmV1NotificationParams)	创建要发送到 Firebase 的通知。
createFcmV1RegistrationDescription(FcmV1RegistrationDescriptionCommon)	创建 Firebase V1 注册说明。
createFcmV1TemplateRegistrationDescription(FcmV1TemplateRegistrationDescriptionCommon)	创建 FCM V1 模板注册说明。
createFirebaseLegacyNotificationBody(FirebaseLegacyNativeMessage)	从本机 Firebase 有效负载创建 FcmLegacyNotification。
createFirebaseV1NotificationBody(FirebaseV1NativeMessageEnvelope)	从本机 Firebase 有效负载创建 FcmV1Notification。
createTagExpression(string[])	从标记列表中创建标记表达式作为 ||表达。
createTemplateNotification(NotificationCommonParams)	创建模板通知。
createWindowsBadgeNotification(WnsNotificationParams)	创建要发送到 WNS 的锁屏提醒消息。
createWindowsBadgeNotificationBody(WindowsBadgeNativeMessage)	从 Windows 锁屏提醒生成 WindowsNotification。
createWindowsInstallation(DeviceTokenInstallation)	创建基于 Windows 通知服务（WNS）的安装。
createWindowsNotification(WnsNotificationParams)	创建要发送到 WNS 的通知。
createWindowsRawNotification(WnsNotificationParams)	创建以 wns/raw 格式发送到 WNS 的通知。
createWindowsRegistrationDescription(WindowsRegistrationDescriptionCommon)	创建 Windows 注册说明。
createWindowsTemplateRegistrationDescription(WindowsTemplateRegistrationDescriptionCommon)	创建 Windows 模板注册说明。
createWindowsTileNotification(WnsNotificationParams)	创建要发送到 WNS 的磁贴消息。
createWindowsToastNotification(WnsNotificationParams)	创建要发送到 WNS 的 Toast 消息。
createXiaomiInstallation(DeviceTokenInstallation)	创建基于小米的安装。
createXiaomiNotification(NotificationCommonParams)	创建要发送到小米的通知。
createXiaomiRegistrationDescription(XiaomiRegistrationDescriptionCommon)	创建小米注册说明。
createXiaomiTemplateRegistrationDescription(XiaomiTemplateRegistrationDescriptionCommon)	创建小米模板注册说明。
isRestError(unknown)	RestError 的 Typeguard

变量

RestError

失败管道请求的自定义错误类型。

函数详细信息

createAdmInstallation(DeviceTokenInstallation)

创建基于 Amazon Device Messaging （ADM） 的安装。

function createAdmInstallation(installation: DeviceTokenInstallation): AdmInstallation

参数

installation

DeviceTokenInstallation

用于创建 ADM 安装的部分安装。

返回

AdmInstallation

新创建的 ADM 安装。

createAdmNotification(AdmNotificationParams)

创建要发送到 Amazon Device Messaging 设备的通知。

function createAdmNotification(notification: AdmNotificationParams): AdmNotification

参数

notification

AdmNotificationParams

用于为 Amazon Device Messaging 创建消息的部分消息。

返回

AdmNotification

新创建的 Amazon Device Messaging。

createAdmNotificationBody(AdmNativeMessage)

从本机 ADM 有效负载创建 AdmNotification。

function createAdmNotificationBody(nativeMessage: AdmNativeMessage): string

参数

nativeMessage

AdmNativeMessage

要发送到通知中心的本机消息有效负载。

返回

string

要发送到通知中心的 AdmNotification。

createAdmRegistrationDescription(AdmRegistrationDescriptionCommon)

创建 ADM 注册说明。

function createAdmRegistrationDescription(description: AdmRegistrationDescriptionCommon): AdmRegistrationDescription

参数

description

AdmRegistrationDescriptionCommon

部分 ADM 注册说明。

返回

AdmRegistrationDescription

已创建的 ADM 注册说明。

createAdmTemplateRegistrationDescription(AdmTemplateRegistrationDescriptionCommon)

创建 ADM 模板注册说明。

function createAdmTemplateRegistrationDescription(description: AdmTemplateRegistrationDescriptionCommon): AdmTemplateRegistrationDescription

参数

description

AdmTemplateRegistrationDescriptionCommon

部分 ADM 模板注册说明。

返回

AdmTemplateRegistrationDescription

已创建的 ADM 模板注册说明。

createAppleInstallation(DeviceTokenInstallation)

创建基于 Apple 的安装。

function createAppleInstallation(installation: DeviceTokenInstallation): AppleInstallation

参数

installation

DeviceTokenInstallation

用于创建 Apple 安装的部分安装。

返回

AppleInstallation

新创建的 Apple 安装。

createAppleNotification(AppleNotificationParams)

创建要发送到 Apple 设备的通知。

function createAppleNotification(notification: AppleNotificationParams): AppleNotification

参数

notification

AppleNotificationParams

用于为 Apple 创建消息的部分消息。

返回

AppleNotification

新创建的 Apple。

createAppleNotificationBody(AppleNativeMessage)

创建要发送到通知中心的 APN 本机消息。

function createAppleNotificationBody(nativeMessage: AppleNativeMessage): string

参数

nativeMessage

AppleNativeMessage

要设置的 Apple 本机消息属性。

返回

string

要发送到通知中心的 AppleNotification。

createAppleRegistrationDescription(AppleRegistrationDescriptionCommon)

创建 Apple 注册说明。

function createAppleRegistrationDescription(description: AppleRegistrationDescriptionCommon): AppleRegistrationDescription

参数

description

AppleRegistrationDescriptionCommon

部分 Apple 注册说明。

返回

AppleRegistrationDescription

已创建的 Apple 注册说明。

createAppleTemplateRegistrationDescription(AppleTemplateRegistrationDescriptionCommon)

创建 Apple 模板注册说明。

function createAppleTemplateRegistrationDescription(description: AppleTemplateRegistrationDescriptionCommon): AppleTemplateRegistrationDescription

参数

description

AppleTemplateRegistrationDescriptionCommon

部分 Apple 模板注册说明。

返回

AppleTemplateRegistrationDescription

已创建的 Apple 模板注册说明。

createBaiduInstallation(DeviceTokenInstallation)

创建基于百度安装的安装。

function createBaiduInstallation(installation: DeviceTokenInstallation): BaiduInstallation

参数

installation

DeviceTokenInstallation

用于创建百度安装的部分安装。

返回

BaiduInstallation

新创建的百度安装。

createBaiduNotification(NotificationCommonParams)

创建要发送到百度注册设备的通知。

function createBaiduNotification(notification: NotificationCommonParams): BaiduNotification

参数

notification

NotificationCommonParams

用于为百度创建消息的部分消息。

返回

BaiduNotification

新创建的百度。

createBaiduNotificationBody(BaiduNativeMessage)

从本机百度有效负载创建百度Notification。

function createBaiduNotificationBody(nativeMessage: BaiduNativeMessage): string

参数

nativeMessage

BaiduNativeMessage

要发送到通知中心的本机消息有效负载。

返回

string

要发送到通知中心的 JSON 正文。

createBaiduRegistrationDescription(BaiduRegistrationDescriptionCommon)

创建百度注册说明。

function createBaiduRegistrationDescription(description: BaiduRegistrationDescriptionCommon): BaiduRegistrationDescription

参数

description

BaiduRegistrationDescriptionCommon

部分百度注册说明。

返回

BaiduRegistrationDescription

创建的百度注册说明。

createBaiduTemplateRegistrationDescription(BaiduTemplateRegistrationDescriptionCommon)

创建百度模板注册说明。

function createBaiduTemplateRegistrationDescription(description: BaiduTemplateRegistrationDescriptionCommon): BaiduTemplateRegistrationDescription

参数

description

BaiduTemplateRegistrationDescriptionCommon

部分百度模板注册说明。

返回

BaiduTemplateRegistrationDescription

创建的百度模板注册说明。

createBrowserInstallation(BrowserInstallationCommon)

创建基于 Web 推送的安装。

function createBrowserInstallation(installation: BrowserInstallationCommon): BrowserInstallation

参数

installation

BrowserInstallationCommon

用于创建 Web 推送安装的部分安装。

返回

BrowserInstallation

新建的 Web 推送安装。

createBrowserNotification(NotificationCommonParams)

创建要发送到浏览器的通知。

function createBrowserNotification(notification: NotificationCommonParams): BrowserNotification

参数

notification

NotificationCommonParams

用于为浏览器创建消息的部分消息。

返回

BrowserNotification

新建的 Web 推送浏览器。

createBrowserRegistrationDescription(BrowserRegistrationDescriptionCommon)

创建 Web 推送注册说明。

function createBrowserRegistrationDescription(description: BrowserRegistrationDescriptionCommon): BrowserRegistrationDescription

参数

description

BrowserRegistrationDescriptionCommon

部分 Web 推送注册说明。

返回

BrowserRegistrationDescription

创建的 Web 推送注册说明。

createBrowserTemplateRegistrationDescription(BrowserTemplateRegistrationDescriptionCommon)

创建 Web 推送注册说明。

function createBrowserTemplateRegistrationDescription(description: BrowserTemplateRegistrationDescriptionCommon): BrowserTemplateRegistrationDescription

参数

description

BrowserTemplateRegistrationDescriptionCommon

部分 Web 推送模板注册说明。

返回

BrowserTemplateRegistrationDescription

创建的 Web 推送模板注册说明。

createFcmLegacyInstallation(DeviceTokenInstallation)

创建基于 Firebase 旧版 HTTP 的安装。

function createFcmLegacyInstallation(installation: DeviceTokenInstallation): FcmLegacyInstallation

参数

installation

DeviceTokenInstallation

用于创建 Firebase 旧版 HTTP 安装的部分安装。

返回

FcmLegacyInstallation

新创建的百度安装。

createFcmLegacyNotification(FcmLegacyNotificationParams)

创建要发送到 Firebase 的通知。

function createFcmLegacyNotification(notification: FcmLegacyNotificationParams): FcmLegacyNotification

参数

notification

FcmLegacyNotificationParams

用于为 Firebase 创建消息的部分消息。

返回

FcmLegacyNotification

新建的 Firebase 通知。

createFcmLegacyRegistrationDescription(GcmRegistrationDescriptionCommon)

创建 Firebase 旧版注册说明。

function createFcmLegacyRegistrationDescription(description: GcmRegistrationDescriptionCommon): GcmRegistrationDescription

参数

description

GcmRegistrationDescriptionCommon

部分 GCM 注册说明。

返回

GcmRegistrationDescription

已创建的 GCM 注册说明。

createFcmLegacyTemplateRegistrationDescription(GcmTemplateRegistrationDescriptionCommon)

创建 GCM 模板注册说明。

function createFcmLegacyTemplateRegistrationDescription(description: GcmTemplateRegistrationDescriptionCommon): GcmTemplateRegistrationDescription

参数

description

GcmTemplateRegistrationDescriptionCommon

部分 GCM 模板注册说明。

返回

GcmTemplateRegistrationDescription

创建的 GCM 模板注册说明。

createFcmV1Installation(DeviceTokenInstallation)

创建基于 Firebase V1 Cloud Messaging 的安装。

function createFcmV1Installation(installation: DeviceTokenInstallation): FcmV1Installation

参数

installation

DeviceTokenInstallation

用于创建 Firebase V1 Cloud Messaging 安装的部分安装。

返回

FcmV1Installation

新创建的 Firebase V1 Cloud Messaging 安装。

createFcmV1Notification(FcmV1NotificationParams)

创建要发送到 Firebase 的通知。

function createFcmV1Notification(notification: FcmV1NotificationParams): FcmV1Notification

参数

notification

FcmV1NotificationParams

用于为 Firebase 创建消息的部分消息。

返回

FcmV1Notification

新建的 Firebase 通知。

createFcmV1RegistrationDescription(FcmV1RegistrationDescriptionCommon)

创建 Firebase V1 注册说明。

function createFcmV1RegistrationDescription(description: FcmV1RegistrationDescriptionCommon): FcmV1RegistrationDescription

参数

description

FcmV1RegistrationDescriptionCommon

部分 FCM V1 注册说明。

返回

FcmV1RegistrationDescription

创建的 FCM V1 注册说明。

createFcmV1TemplateRegistrationDescription(FcmV1TemplateRegistrationDescriptionCommon)

创建 FCM V1 模板注册说明。

function createFcmV1TemplateRegistrationDescription(description: FcmV1TemplateRegistrationDescriptionCommon): FcmV1TemplateRegistrationDescription

参数

description

FcmV1TemplateRegistrationDescriptionCommon

部分 FCM V1 模板注册说明。

返回

FcmV1TemplateRegistrationDescription

创建的 FCM V1 模板注册说明。

createFirebaseLegacyNotificationBody(FirebaseLegacyNativeMessage)

从本机 Firebase 有效负载创建 FcmLegacyNotification。

function createFirebaseLegacyNotificationBody(nativeMessage: FirebaseLegacyNativeMessage): string

参数

nativeMessage

FirebaseLegacyNativeMessage

要发送到通知中心的本机消息有效负载。

返回

string

要发送到通知中心的 JSON 正文。

createFirebaseV1NotificationBody(FirebaseV1NativeMessageEnvelope)

从本机 Firebase 有效负载创建 FcmV1Notification。

function createFirebaseV1NotificationBody(nativeMessage: FirebaseV1NativeMessageEnvelope): string

参数

nativeMessage

FirebaseV1NativeMessageEnvelope

要发送到通知中心的本机消息有效负载。

返回

string

要发送到通知中心的 JSON 正文。

createTagExpression(string[])

从标记列表中创建标记表达式作为 ||表达。

function createTagExpression(tags: string[]): string

参数

tags

string[]

要创建 || 的标记表达

返回

string

从字符串数组到 || 的标记表达式表达。

createTemplateNotification(NotificationCommonParams)

创建模板通知。

function createTemplateNotification(notification: NotificationCommonParams): TemplateNotification

参数

notification

NotificationCommonParams

用于模板通知的部分消息。

返回

TemplateNotification

新建的 Firebase。

createWindowsBadgeNotification(WnsNotificationParams)

创建要发送到 WNS 的锁屏提醒消息。

function createWindowsBadgeNotification(notification: WnsNotificationParams): WindowsNotification

参数

notification

WnsNotificationParams

用于为 WNS 创建锁屏提醒消息的部分消息。

返回

WindowsNotification

新建的 WNS 锁屏提醒。

createWindowsBadgeNotificationBody(WindowsBadgeNativeMessage)

从 Windows 锁屏提醒生成 WindowsNotification。

function createWindowsBadgeNotificationBody(nativeMessage: WindowsBadgeNativeMessage): string

参数

nativeMessage

WindowsBadgeNativeMessage

要生成的 Windows 锁屏提醒消息。

返回

string

使用锁屏提醒信息创建的 WNS XML。

createWindowsInstallation(DeviceTokenInstallation)

创建基于 Windows 通知服务（WNS）的安装。

function createWindowsInstallation(installation: DeviceTokenInstallation): WindowsInstallation

参数

installation

DeviceTokenInstallation

用于创建 WNS 安装的部分安装。

返回

WindowsInstallation

新创建的 WNS 安装。

createWindowsNotification(WnsNotificationParams)

创建要发送到 WNS 的通知。

function createWindowsNotification(notification: WnsNotificationParams): WindowsNotification

参数

notification

WnsNotificationParams

要发送的 WNS 通知。

返回

WindowsNotification

新建的 WNS 消息。

createWindowsRawNotification(WnsNotificationParams)

创建以 wns/raw 格式发送到 WNS 的通知。

function createWindowsRawNotification(notification: WnsNotificationParams): WindowsNotification

参数

notification

WnsNotificationParams

用于以 XML 格式为 WNS 创建消息的部分消息。

返回

WindowsNotification

使用 XML 新建的 WNS 消息。

createWindowsRegistrationDescription(WindowsRegistrationDescriptionCommon)

创建 Windows 注册说明。

function createWindowsRegistrationDescription(description: WindowsRegistrationDescriptionCommon): WindowsRegistrationDescription

参数

description

WindowsRegistrationDescriptionCommon

部分 Windows 注册说明。

返回

WindowsRegistrationDescription

已创建的 Windows 注册说明。

createWindowsTemplateRegistrationDescription(WindowsTemplateRegistrationDescriptionCommon)

创建 Windows 模板注册说明。

function createWindowsTemplateRegistrationDescription(description: WindowsTemplateRegistrationDescriptionCommon): WindowsTemplateRegistrationDescription

参数

description

WindowsTemplateRegistrationDescriptionCommon

部分 Windows 模板注册说明。

返回

WindowsTemplateRegistrationDescription

已创建的 Windows 模板注册说明。

createWindowsTileNotification(WnsNotificationParams)

创建要发送到 WNS 的磁贴消息。

function createWindowsTileNotification(notification: WnsNotificationParams): WindowsNotification

参数

notification

WnsNotificationParams

用于为 WNS 创建磁贴消息的部分消息。

返回

WindowsNotification

新建的 WNS 磁贴。

createWindowsToastNotification(WnsNotificationParams)

创建要发送到 WNS 的 Toast 消息。

function createWindowsToastNotification(notification: WnsNotificationParams): WindowsNotification

参数

notification

WnsNotificationParams

用于为 WNS 创建 Toast 消息的部分消息。

返回

WindowsNotification

新建的 WNS Toast。

createXiaomiInstallation(DeviceTokenInstallation)

创建基于小米的安装。

function createXiaomiInstallation(installation: DeviceTokenInstallation): XiaomiInstallation

参数

installation

DeviceTokenInstallation

用于创建小米安装的部分安装。

返回

XiaomiInstallation

新创建的小米安装。

createXiaomiNotification(NotificationCommonParams)

创建要发送到小米的通知。

function createXiaomiNotification(notification: NotificationCommonParams): XiaomiNotification

参数

notification

NotificationCommonParams

用于为小米创建消息的部分消息。

返回

XiaomiNotification

新创建的小米通知。

createXiaomiRegistrationDescription(XiaomiRegistrationDescriptionCommon)

创建小米注册说明。

function createXiaomiRegistrationDescription(description: XiaomiRegistrationDescriptionCommon): XiaomiRegistrationDescription

参数

description

XiaomiRegistrationDescriptionCommon

部分小米注册说明。

返回

XiaomiRegistrationDescription

已创建的小米注册说明。

createXiaomiTemplateRegistrationDescription(XiaomiTemplateRegistrationDescriptionCommon)

创建小米模板注册说明。

function createXiaomiTemplateRegistrationDescription(description: XiaomiTemplateRegistrationDescriptionCommon): XiaomiTemplateRegistrationDescription

参数

description

XiaomiTemplateRegistrationDescriptionCommon

部分小米模板注册说明。

返回

XiaomiTemplateRegistrationDescription

已创建的小米模板注册说明。

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

参数

e

unknown

catch 子句捕获的内容。

返回

e

变量详细信息

RestError

失败管道请求的自定义错误类型。

RestError: RestErrorConstructor

类型

RestErrorConstructor