@azure/notification-hubs package
類別
| NotificationHubsClient |
這代表 Azure 通知中樞的用戶端來管理安裝,並將訊息傳送至裝置。 |
介面
類型別名
| 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) 型安裝。
function createAdmInstallation(installation: DeviceTokenInstallation): AdmInstallation
參數
- installation
- DeviceTokenInstallation
用來建立ADM安裝的部分安裝。
傳回
新建立的ADM安裝。
createAdmNotification(AdmNotificationParams)
建立通知以傳送至 Amazon 裝置傳訊裝置。
function createAdmNotification(notification: AdmNotificationParams): AdmNotification
參數
- notification
- AdmNotificationParams
用來建立 Amazon 裝置傳訊訊息的部分訊息。
傳回
新建立的 Amazon 裝置傳訊。
createAdmNotificationBody(AdmNativeMessage)
從原生 ADM 承載建立 AdmNotification。
function createAdmNotificationBody(nativeMessage: AdmNativeMessage): string
參數
- nativeMessage
- AdmNativeMessage
要傳送至通知中樞的原生訊息承載。
傳回
string
要傳送至通知中樞的 AdmNotification。
createAdmRegistrationDescription(AdmRegistrationDescriptionCommon)
建立 ADM 註冊描述。
function createAdmRegistrationDescription(description: AdmRegistrationDescriptionCommon): AdmRegistrationDescription
參數
- description
- AdmRegistrationDescriptionCommon
部分 ADM 註冊描述。
傳回
已建立的 ADM 註冊描述。
createAdmTemplateRegistrationDescription(AdmTemplateRegistrationDescriptionCommon)
建立 ADM 範本註冊描述。
function createAdmTemplateRegistrationDescription(description: AdmTemplateRegistrationDescriptionCommon): AdmTemplateRegistrationDescription
參數
- description
- AdmTemplateRegistrationDescriptionCommon
部分 ADM 範本註冊描述。
傳回
已建立的 ADM 範本註冊描述。
createAppleInstallation(DeviceTokenInstallation)
建立 Apple 型安裝。
function createAppleInstallation(installation: DeviceTokenInstallation): AppleInstallation
參數
- installation
- DeviceTokenInstallation
用來建立Apple安裝的部分安裝。
傳回
新建立的Apple安裝。
createAppleNotification(AppleNotificationParams)
建立要傳送至 Apple 裝置的通知。
function createAppleNotification(notification: AppleNotificationParams): AppleNotification
參數
- notification
- AppleNotificationParams
用來建立Apple訊息的部分訊息。
傳回
新建立的Apple。
createAppleNotificationBody(AppleNativeMessage)
建立APNs原生訊息以傳送至通知中樞。
function createAppleNotificationBody(nativeMessage: AppleNativeMessage): string
參數
- nativeMessage
- AppleNativeMessage
要設定的Apple原生訊息屬性。
傳回
string
要傳送至通知中樞的AppleNotification。
createAppleRegistrationDescription(AppleRegistrationDescriptionCommon)
建立Apple 註冊描述。
function createAppleRegistrationDescription(description: AppleRegistrationDescriptionCommon): AppleRegistrationDescription
參數
- description
- AppleRegistrationDescriptionCommon
部分Apple註冊描述。
傳回
已建立的Apple註冊描述。
createAppleTemplateRegistrationDescription(AppleTemplateRegistrationDescriptionCommon)
建立Apple範本註冊描述。
function createAppleTemplateRegistrationDescription(description: AppleTemplateRegistrationDescriptionCommon): AppleTemplateRegistrationDescription
參數
- description
- AppleTemplateRegistrationDescriptionCommon
部分Apple範本註冊描述。
傳回
已建立的 Apple 範本註冊描述。
createBaiduInstallation(DeviceTokenInstallation)
建立百度型安裝。
function createBaiduInstallation(installation: DeviceTokenInstallation): BaiduInstallation
參數
- installation
- DeviceTokenInstallation
用來建立百度安裝的部分安裝。
傳回
新建立的百度安裝。
createBaiduNotification(NotificationCommonParams)
建立通知以傳送至百度已註冊的裝置。
function createBaiduNotification(notification: NotificationCommonParams): BaiduNotification
參數
- notification
- NotificationCommonParams
用來建立百度訊息的部分訊息。
傳回
新建立的百度。
createBaiduNotificationBody(BaiduNativeMessage)
從原生百度承載建立百度Notification。
function createBaiduNotificationBody(nativeMessage: BaiduNativeMessage): string
參數
- nativeMessage
- BaiduNativeMessage
要傳送至通知中樞的原生訊息承載。
傳回
string
要傳送至通知中樞的 JSON 主體。
createBaiduRegistrationDescription(BaiduRegistrationDescriptionCommon)
建立百度註冊描述。
function createBaiduRegistrationDescription(description: BaiduRegistrationDescriptionCommon): BaiduRegistrationDescription
參數
- description
- BaiduRegistrationDescriptionCommon
部分百度註冊描述。
傳回
已建立百度註冊描述。
createBaiduTemplateRegistrationDescription(BaiduTemplateRegistrationDescriptionCommon)
建立百度範本註冊描述。
function createBaiduTemplateRegistrationDescription(description: BaiduTemplateRegistrationDescriptionCommon): BaiduTemplateRegistrationDescription
參數
- description
- BaiduTemplateRegistrationDescriptionCommon
部分百度範本註冊描述。
傳回
已建立的百度範本註冊描述。
createBrowserInstallation(BrowserInstallationCommon)
建立 Web Push 型安裝。
function createBrowserInstallation(installation: BrowserInstallationCommon): BrowserInstallation
參數
- installation
- BrowserInstallationCommon
用來建立 Web 推入安裝的部分安裝。
傳回
新建立的 Web Push 安裝。
createBrowserNotification(NotificationCommonParams)
建立要傳送至瀏覽器的通知。
function createBrowserNotification(notification: NotificationCommonParams): BrowserNotification
參數
- notification
- NotificationCommonParams
用來建立瀏覽器訊息的部分訊息。
傳回
新建立的網頁推入瀏覽器。
createBrowserRegistrationDescription(BrowserRegistrationDescriptionCommon)
建立 Web Push 註冊描述。
function createBrowserRegistrationDescription(description: BrowserRegistrationDescriptionCommon): BrowserRegistrationDescription
參數
- description
- BrowserRegistrationDescriptionCommon
部分 Web Push 註冊描述。
傳回
已建立的 Web Push 註冊描述。
createBrowserTemplateRegistrationDescription(BrowserTemplateRegistrationDescriptionCommon)
建立 Web Push 註冊描述。
function createBrowserTemplateRegistrationDescription(description: BrowserTemplateRegistrationDescriptionCommon): BrowserTemplateRegistrationDescription
參數
- description
- BrowserTemplateRegistrationDescriptionCommon
部分 Web Push 範本註冊描述。
傳回
已建立的 Web Push 範本註冊描述。
createFcmLegacyInstallation(DeviceTokenInstallation)
建立 Firebase 舊版 HTTP 型安裝。
function createFcmLegacyInstallation(installation: DeviceTokenInstallation): FcmLegacyInstallation
參數
- installation
- DeviceTokenInstallation
用來建立 Firebase 舊版 HTTP 安裝的部分安裝。
傳回
新建立的百度安裝。
createFcmLegacyNotification(FcmLegacyNotificationParams)
建立要傳送至 Firebase 的通知。
function createFcmLegacyNotification(notification: FcmLegacyNotificationParams): FcmLegacyNotification
參數
- notification
- FcmLegacyNotificationParams
用來建立 Firebase 訊息的部分訊息。
傳回
新建立的 Firebase 通知。
createFcmLegacyRegistrationDescription(GcmRegistrationDescriptionCommon)
建立 Firebase 舊版註冊描述。
function createFcmLegacyRegistrationDescription(description: GcmRegistrationDescriptionCommon): GcmRegistrationDescription
參數
- description
- GcmRegistrationDescriptionCommon
部分 GCM 註冊描述。
傳回
已建立的 GCM 註冊描述。
createFcmLegacyTemplateRegistrationDescription(GcmTemplateRegistrationDescriptionCommon)
建立 GCM 範本註冊描述。
function createFcmLegacyTemplateRegistrationDescription(description: GcmTemplateRegistrationDescriptionCommon): GcmTemplateRegistrationDescription
參數
- description
- GcmTemplateRegistrationDescriptionCommon
部分 GCM 範本註冊描述。
傳回
已建立的 GCM 範本註冊描述。
createFcmV1Installation(DeviceTokenInstallation)
建立以 Firebase V1 雲端傳訊為基礎的安裝。
function createFcmV1Installation(installation: DeviceTokenInstallation): FcmV1Installation
參數
- installation
- DeviceTokenInstallation
用來建立 Firebase V1 雲端傳訊安裝的部分安裝。
傳回
新建立的 Firebase V1 雲端傳訊安裝。
createFcmV1Notification(FcmV1NotificationParams)
建立要傳送至 Firebase 的通知。
function createFcmV1Notification(notification: FcmV1NotificationParams): FcmV1Notification
參數
- notification
- FcmV1NotificationParams
用來建立 Firebase 訊息的部分訊息。
傳回
新建立的 Firebase 通知。
createFcmV1RegistrationDescription(FcmV1RegistrationDescriptionCommon)
建立 Firebase V1 註冊描述。
function createFcmV1RegistrationDescription(description: FcmV1RegistrationDescriptionCommon): FcmV1RegistrationDescription
參數
- description
- FcmV1RegistrationDescriptionCommon
部分 FCM V1 註冊描述。
傳回
已建立的 FCM V1 註冊描述。
createFcmV1TemplateRegistrationDescription(FcmV1TemplateRegistrationDescriptionCommon)
建立 FCM V1 範本註冊描述。
function createFcmV1TemplateRegistrationDescription(description: FcmV1TemplateRegistrationDescriptionCommon): FcmV1TemplateRegistrationDescription
參數
- description
- FcmV1TemplateRegistrationDescriptionCommon
部分 FCM V1 範本註冊描述。
傳回
已建立的 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
用於範本通知的部分訊息。
傳回
新建立的 Firebase。
createWindowsBadgeNotification(WnsNotificationParams)
建立要傳送至 WNS 的徽章訊息。
function createWindowsBadgeNotification(notification: WnsNotificationParams): WindowsNotification
參數
- notification
- WnsNotificationParams
用來建立 WNS 徽章訊息的部分訊息。
傳回
新建立的 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 安裝的部分安裝。
傳回
新建立的 WNS 安裝。
createWindowsNotification(WnsNotificationParams)
建立要傳送至 WNS 的通知。
function createWindowsNotification(notification: WnsNotificationParams): WindowsNotification
參數
- notification
- WnsNotificationParams
要傳送的 WNS 通知。
傳回
新建立的 WNS 訊息。
createWindowsRawNotification(WnsNotificationParams)
建立通知,以 wns/raw 格式傳送至 WNS。
function createWindowsRawNotification(notification: WnsNotificationParams): WindowsNotification
參數
- notification
- WnsNotificationParams
用來以 XML 格式建立 WNS 訊息的部分訊息。
傳回
使用 XML 新建立的 WNS 訊息。
createWindowsRegistrationDescription(WindowsRegistrationDescriptionCommon)
建立 Windows 註冊描述。
function createWindowsRegistrationDescription(description: WindowsRegistrationDescriptionCommon): WindowsRegistrationDescription
參數
- description
- WindowsRegistrationDescriptionCommon
部分 Windows 註冊描述。
傳回
已建立的 Windows 註冊描述。
createWindowsTemplateRegistrationDescription(WindowsTemplateRegistrationDescriptionCommon)
建立 Windows 範本註冊描述。
function createWindowsTemplateRegistrationDescription(description: WindowsTemplateRegistrationDescriptionCommon): WindowsTemplateRegistrationDescription
參數
- description
- WindowsTemplateRegistrationDescriptionCommon
部分 Windows 範本註冊描述。
傳回
已建立的 Windows 範本註冊描述。
createWindowsTileNotification(WnsNotificationParams)
建立要傳送至 WNS 的磚訊息。
function createWindowsTileNotification(notification: WnsNotificationParams): WindowsNotification
參數
- notification
- WnsNotificationParams
用來建立 WNS 磚訊息的部分訊息。
傳回
新建立的 WNS 圖格。
createWindowsToastNotification(WnsNotificationParams)
建立要傳送至 WNS 的快顯通知訊息。
function createWindowsToastNotification(notification: WnsNotificationParams): WindowsNotification
參數
- notification
- WnsNotificationParams
用來建立 WNS 快顯通知訊息的部分訊息。
傳回
新建立的 WNS 快顯通知。
createXiaomiInstallation(DeviceTokenInstallation)
建立小米型安裝。
function createXiaomiInstallation(installation: DeviceTokenInstallation): XiaomiInstallation
參數
- installation
- DeviceTokenInstallation
用來建立小米安裝的部分安裝。
傳回
新建立的小米安裝。
createXiaomiNotification(NotificationCommonParams)
建立要傳送至小米的通知。
function createXiaomiNotification(notification: NotificationCommonParams): XiaomiNotification
參數
- notification
- NotificationCommonParams
用來建立小米訊息的部分訊息。
傳回
新建立的小米通知。
createXiaomiRegistrationDescription(XiaomiRegistrationDescriptionCommon)
建立小米註冊描述。
function createXiaomiRegistrationDescription(description: XiaomiRegistrationDescriptionCommon): XiaomiRegistrationDescription
參數
- description
- XiaomiRegistrationDescriptionCommon
部分小米註冊描述。
傳回
已建立的小米註冊描述。
createXiaomiTemplateRegistrationDescription(XiaomiTemplateRegistrationDescriptionCommon)
建立小米範本註冊描述。
function createXiaomiTemplateRegistrationDescription(description: XiaomiTemplateRegistrationDescriptionCommon): XiaomiTemplateRegistrationDescription
參數
- description
- XiaomiTemplateRegistrationDescriptionCommon
部分小米範本註冊描述。
傳回
已建立的小米範本註冊描述。