@azure/notification-hubs package
Classes
| NotificationHubsClient |
This represents a client for Azure Notification Hubs to manage installations and send messages to devices. |
Interfaces
| AdmInstallation |
Represents an Amazon Device Messaging (ADM) based installation. |
| AdmNativeMessage |
Represents a native ADM notification message payload. |
| AdmNativeNotification |
Describes ADM notification messages. |
| AdmNotification |
Represents an Amazon Device Messaging (ADM) push notification. |
| AdmNotificationParams |
Represents an ADM notification that can be sent to a device. |
| AdmRegistrationChannel |
Describes an ADM Registration channel query. |
| AdmRegistrationDescription |
Represents the description of the Amazon Device Messaging (ADM) registration. |
| AdmRegistrationDescriptionCommon |
Represents a registration description. |
| AdmTemplateRegistrationDescription |
Represents the description of the Amazon Device Messaging (ADM) template registration. |
| AdmTemplateRegistrationDescriptionCommon |
Represents the description of the Amazon Device Messaging (ADM) template registration. |
| AppleAlert |
Represents what is in the APNs alert body. |
| AppleApsNativeMessage |
Represents a native APNs APS message. |
| AppleCriticalSound |
Represents an APNs critical sound |
| AppleHeaders |
The list of APNs specific headers. |
| AppleInstallation |
Represents an Apple APNs based installation. |
| AppleNativeMessage |
Represents a native APNs message. |
| AppleNotification |
Represents an Apple APNs push notification. |
| AppleNotificationParams |
Represents an Apple notification that can be sent to a device. |
| AppleRegistrationChannel |
Describes an Apple Registration channel query. |
| AppleRegistrationDescription |
Represents the description of apple registration. |
| AppleRegistrationDescriptionCommon |
Represents the description of apple registration. |
| AppleTemplateRegistrationDescription |
Represents the description of the Apple template registration. |
| AppleTemplateRegistrationDescriptionCommon |
Represents the description of the Apple template registration. |
| BaiduAppleNativePayload |
Represents the Baidu Apple native payload. |
| BaiduInstallation |
Represents a Baidu based installation. |
| BaiduNativeMessage |
Baidu Native Format: https://stackoverflow.com/questions/42591815/customize-baidu-push-json-payload http://www.tuicool.com/articles/ZnmANn |
| BaiduNotification |
Represents a Baidu push notification. |
| BaiduRegistrationChannel |
Describes an Baidu Registration channel query. |
| BaiduRegistrationDescription |
Represents a Baidu registration description. |
| BaiduRegistrationDescriptionCommon |
Represents a registration description. |
| BaiduTemplateRegistrationDescription |
Represents a Baidu template registration description. |
| BaiduTemplateRegistrationDescriptionCommon |
Represents a Baidu template registration description. |
| BrowserInstallation |
Represents a Browser/Web Push based installation. |
| BrowserInstallationCommon |
Represents a Browser/Web Push based installation. |
| BrowserNotification |
Represents a Browser push notification. |
| BrowserPushChannel |
Represents the push channel for a Browser Push installation. |
| BrowserRegistrationChannel |
Describes an Browser Registration channel query. |
| BrowserRegistrationDescription |
Represents a Browser Push registration description. |
| BrowserRegistrationDescriptionCommon |
Represents a Browser Push registration description. |
| BrowserTemplateRegistrationDescription |
Represents a Browser Push remplate registration description. |
| BrowserTemplateRegistrationDescriptionCommon |
Represents a Browser Push remplate registration description. |
| DeviceTokenInstallation |
Represents an installation with a string based device token. |
| DirectSendNotificationOptions |
Options for sending notifications to individual devices. |
| EntityOperationOptions |
Represents entity update operation options that can be set. |
| FcmLegacyInstallation |
Represents a Firebase Legacy HTTP installation. |
| FcmLegacyNotification |
Represents a Firebase legacy HTTP push notification. |
| FcmLegacyNotificationParams |
Represents an Firebase Legacy notification that can be sent to a device. |
| FcmV1Installation |
Represents an Firebase V1 Cloud Messaging based installation. |
| FcmV1Notification |
Represents an Firebase V1 API notification that can be sent to a device. |
| FcmV1NotificationParams |
Represents an Firebase V1 notification that can be sent to a device. |
| FcmV1RegistrationDescription |
Represents Notification Hub registration description for Google Cloud Messaging. |
| FcmV1RegistrationDescriptionCommon |
Represents Notification Hub registration description for Google Cloud Messaging. |
| FcmV1TemplateRegistrationDescription |
Represents Notification Hub template registration description for Firebase V1 Cloud Messaging. |
| FcmV1TemplateRegistrationDescriptionCommon |
Represents Notification Hub template registration description for Firebase V1 Cloud Messaging. |
| FirebaseLegacyAndroidNativePayload |
Represents an Android native payload for the Firebase Legacy HTTP interface. |
| FirebaseLegacyAppleNativePayload |
Represents an APNs native payload for the Firebase Legacy HTTP interface. |
| FirebaseLegacyNativeMessage |
Represents the targets, options, and payload for HTTP JSON messages for the Firebase Legacy HTTP interface. |
| FirebaseLegacyRegistrationChannel |
Describes an Firebase Legacy Registration channel query. |
| FirebaseLegacyWebNativePayload |
Represents an Web Push native payload for the Firebase Legacy HTTP interface. |
| FirebaseV1AndroidConfig |
Android specific options for messages sent through FCM connection server. |
| FirebaseV1AndroidFcmOptions |
Options for features provided by the FCM SDK for Android. |
| FirebaseV1AndroidNotification |
Notification to send to android devices. |
| FirebaseV1ApnsConfig |
Apple Push Notification Service specific options. |
| FirebaseV1ApnsFcmOptions |
Options for features provided by the FCM SDK for iOS. |
| FirebaseV1FcmOptions | |
| FirebaseV1NativeMessage |
Represents the targets, options, and payload for HTTP JSON messages for the Firebase V1 interface. |
| FirebaseV1NativeMessageEnvelope |
Represents the Firebase V1 native message envelope. |
| FirebaseV1NativeNotification |
Represents a native FCM V1 notification message payload. |
| FirebaseV1RegistrationChannel |
Describes an Firebase Legacy Registration channel query. |
| FirebaseV1WebPushConfig | |
| FirebaseV1WebPushFcmOptions |
Options for features provided by the FCM SDK for Web. |
| FirebaseV1WebPushNotification |
Represents a Web Push notification payload. |
| GcmRegistrationDescription |
Represents Notification Hub registration description for Google Cloud Messaging. |
| GcmRegistrationDescriptionCommon |
Represents Notification Hub registration description for Google Cloud Messaging. |
| GcmTemplateRegistrationDescription |
Represents Notification Hub template registration description for Firebase Legacy Cloud Messaging. |
| GcmTemplateRegistrationDescriptionCommon |
Represents Notification Hub template registration description for Firebase Legacy Cloud Messaging. |
| InstallationCommon |
Represents an installation for a device for Notification Hubs. |
| InstallationTemplate |
Represents an installation template. |
| JsonNotification |
Represents a JSON notification hub. |
| JsonPatch |
Represents a patch operation. |
| MpnsRegistrationDescription |
Represents a Windows Phone Notification Services registration description. |
| MpnsRegistrationDescriptionCommon |
Represents a Windows Phone Notification Services registration description. |
| MpnsTemplateRegistrationDescription |
Represents a Windows Phone Notification Services template registration. |
| MpnsTemplateRegistrationDescriptionCommon |
Represents a Windows Phone Notification Services template registration. |
| NotificationCommon |
Represents a notification that can be sent to a device. |
| NotificationCommonParams |
The common notification parameters to accept a string body or JSON body. |
| NotificationDetails |
Represents Notification details. |
| NotificationHubJob |
Represents a Notification Hub Job. |
| NotificationHubsClientOptions |
Describes the options that can be provided while creating the NotificationHubsClientContext. |
| NotificationHubsMessageResponse |
Describes a response from the Notification Hubs service for send operations. |
| NotificationHubsResponse |
Describes a response from the Notification Hubs which includes a tracking ID, correlation ID and location. |
| NotificationOutcome |
The per platform count per state. |
| PolledOperationOptions |
Options for polled operations including the polling interval cycle. |
| RegistrationDescriptionCommon |
Represents a registration description. |
| RegistrationQueryLimitOptions |
Represents query options to include $top support. |
| RegistrationQueryOptions |
Represents query options to include both $top and $filter. |
| RegistrationQueryResponse |
Describes a registration query response with registrations and a continuation token. |
| RegistrationResult |
Represents the result of the registration. |
| ScheduleNotificationOptions |
Options for sending notifications for both tag based send and broadcast scheduled send. |
| SendNotificationOptions |
Options for sending notifications for both tag based send and broadcast send. |
| TemplateNotification |
Represents a template based push notification. |
| TemplateRegistrationDescription |
Represents the description of a template registration. |
| WindowsBadgeNativeMessage |
Represents the Windows Badge Message |
| WindowsHeaders |
List of WNS specific headers. |
| WindowsInstallation |
Represents a Windows Notification Services (WNS) based installation. |
| WindowsNotification |
Represents a Windows Notification Services (WNS) push notification. |
| WindowsRegistrationChannel |
Describes an Windows Notification Services Registration channel query. |
| WindowsRegistrationDescription |
Represents a Windows Notification Services (WNS) registration description. |
| WindowsRegistrationDescriptionCommon |
Represents a Windows Notification Services (WNS) registration description. |
| WindowsTemplateRegistrationDescription |
Represents a Windows Notification Services (WNS) template registration. |
| WindowsTemplateRegistrationDescriptionCommon |
Represents a Windows Notification Services (WNS) template registration. |
| WnsNotificationParams |
Represents a WNS notification that can be sent to a device. |
| XiaomiInstallation |
Represents a Xiaomi based installation. |
| XiaomiNotification |
Represents a Xiaomi push notification. |
| XiaomiRegistrationChannel |
Describes an Xiaomi Registration channel query. |
| XiaomiRegistrationDescription |
Represents a Xiaomi registration description. |
| XiaomiRegistrationDescriptionCommon |
Represents a Xiaomi registration description. |
| XiaomiTemplateRegistrationDescription |
Represents a Windows Notification Services (WNS) template registration. |
| XiaomiTemplateRegistrationDescriptionCommon |
Represents a Xiaomi template registration. |
Type Aliases
| ApnsPushTypes |
Describes the types of APNs pushes. |
| Installation |
Represents the types of installations available in Notification Hubs. |
| JsonPatchOperation |
Represents the JSON Patch types of add, remove and replace. |
| Notification |
Represents the possible push notification messages types. |
| NotificationHubJobPoller |
Describes a poller for NotificationHubJob types. |
| NotificationHubJobStatus |
Describes the types of notification hub job statuses. |
| NotificationHubJobType |
Describes the types of notification hub jobs. |
| NotificationOutcomeState |
Represents the notification outcome states. |
| PushHandle |
Represents the types of push channels available for Notification Hubs. |
| RegistrationChannel |
Describes a Registration query. |
| RegistrationDescription |
Describes the types of registration descriptions. |
| RegistrationType |
Represents the types of registration descriptions. |
| WindowsBadgeGlyphType |
Represents the types of Windows Badge Glyphs |
| WindowsContentType |
Represents the possible WNS content-types. |
| WnsTypes |
The list of WNS specific types. |
Functions
Function Details
createAdmInstallation(DeviceTokenInstallation)
Creates an Amazon Device Messaging (ADM) based installation.
function createAdmInstallation(installation: DeviceTokenInstallation): AdmInstallationParameters
- installation
- DeviceTokenInstallation
A partial installation used to create the ADM installation.
Returns
The newly created ADM installation.
createAdmNotification(AdmNotificationParams)
Creates a notification to send to an Amazon Device Messaging device.
function createAdmNotification(notification: AdmNotificationParams): AdmNotificationParameters
- notification
- AdmNotificationParams
A partial message used to create a message for Amazon Device Messaging.
Returns
A newly created Amazon Device Messaging.
createAdmNotificationBody(AdmNativeMessage)
Creates a AdmNotification from a native ADM payload.
function createAdmNotificationBody(nativeMessage: AdmNativeMessage): stringParameters
- nativeMessage
- AdmNativeMessage
The native message payload to send to Notification Hubs.
Returns
string
The AdmNotification to send to Notification Hubs.
createAdmRegistrationDescription(AdmRegistrationDescriptionCommon)
Creates an ADM registration description.
function createAdmRegistrationDescription(description: AdmRegistrationDescriptionCommon): AdmRegistrationDescriptionParameters
- description
- AdmRegistrationDescriptionCommon
A partial ADM registration description.
Returns
A created ADM registration description.
createAdmTemplateRegistrationDescription(AdmTemplateRegistrationDescriptionCommon)
Creates an ADM template registration description.
function createAdmTemplateRegistrationDescription(description: AdmTemplateRegistrationDescriptionCommon): AdmTemplateRegistrationDescriptionParameters
- description
- AdmTemplateRegistrationDescriptionCommon
A partial ADM template registration description.
Returns
A created ADM template registration description.
createAppleInstallation(DeviceTokenInstallation)
Creates an Apple based installation.
function createAppleInstallation(installation: DeviceTokenInstallation): AppleInstallationParameters
- installation
- DeviceTokenInstallation
A partial installation used to create the Apple installation.
Returns
The newly created Apple installation.
createAppleNotification(AppleNotificationParams)
Creates a notification to send to an Apple device.
function createAppleNotification(notification: AppleNotificationParams): AppleNotificationParameters
- notification
- AppleNotificationParams
A partial message used to create a message for Apple.
Returns
A newly created Apple.
createAppleNotificationBody(AppleNativeMessage)
Creates an APNs native message to send to Notification Hubs.
function createAppleNotificationBody(nativeMessage: AppleNativeMessage): stringParameters
- nativeMessage
- AppleNativeMessage
The Apple native message properties to set.
Returns
string
An AppleNotification to send to Notification Hubs.
createAppleRegistrationDescription(AppleRegistrationDescriptionCommon)
Creates an Apple registration description.
function createAppleRegistrationDescription(description: AppleRegistrationDescriptionCommon): AppleRegistrationDescriptionParameters
- description
- AppleRegistrationDescriptionCommon
A partial Apple registration description.
Returns
A created Apple registration description.
createAppleTemplateRegistrationDescription(AppleTemplateRegistrationDescriptionCommon)
Creates an Apple template registration description.
function createAppleTemplateRegistrationDescription(description: AppleTemplateRegistrationDescriptionCommon): AppleTemplateRegistrationDescriptionParameters
- description
- AppleTemplateRegistrationDescriptionCommon
A partial Apple template registration description.
Returns
A created Apple template registration description.
createBaiduInstallation(DeviceTokenInstallation)
Creates a Baidu based installation.
function createBaiduInstallation(installation: DeviceTokenInstallation): BaiduInstallationParameters
- installation
- DeviceTokenInstallation
A partial installation used to create the Baidu installation.
Returns
The newly created Baidu installation.
createBaiduNotification(NotificationCommonParams)
Creates a notification to send to a Baidu registered device.
function createBaiduNotification(notification: NotificationCommonParams): BaiduNotificationParameters
- notification
- NotificationCommonParams
A partial message used to create a message for Baidu.
Returns
A newly created Baidu.
createBaiduNotificationBody(BaiduNativeMessage)
Creates a BaiduNotification from a native Baidu payload.
function createBaiduNotificationBody(nativeMessage: BaiduNativeMessage): stringParameters
- nativeMessage
- BaiduNativeMessage
The native message payload to send to Notification Hubs.
Returns
string
The JSON body to send to Notification Hubs.
createBaiduRegistrationDescription(BaiduRegistrationDescriptionCommon)
Creates a Baidu registration description.
function createBaiduRegistrationDescription(description: BaiduRegistrationDescriptionCommon): BaiduRegistrationDescriptionParameters
- description
- BaiduRegistrationDescriptionCommon
A partial Baidu registration description.
Returns
A created Baidu registration description.
createBaiduTemplateRegistrationDescription(BaiduTemplateRegistrationDescriptionCommon)
Creates a Baidu template registration description.
function createBaiduTemplateRegistrationDescription(description: BaiduTemplateRegistrationDescriptionCommon): BaiduTemplateRegistrationDescriptionParameters
- description
- BaiduTemplateRegistrationDescriptionCommon
A partial Baidu template registration description.
Returns
A created Baidu template registration description.
createBrowserInstallation(BrowserInstallationCommon)
Creates a Web Push based installation.
function createBrowserInstallation(installation: BrowserInstallationCommon): BrowserInstallationParameters
- installation
- BrowserInstallationCommon
A partial installation used to create the Web Push installation.
Returns
The newly created Web Push installation.
createBrowserNotification(NotificationCommonParams)
Creates a notification to send to a browser.
function createBrowserNotification(notification: NotificationCommonParams): BrowserNotificationParameters
- notification
- NotificationCommonParams
A partial message used to create a message for a browser.
Returns
A newly created Web Push browser.
createBrowserRegistrationDescription(BrowserRegistrationDescriptionCommon)
Creates a Web Push registration description.
function createBrowserRegistrationDescription(description: BrowserRegistrationDescriptionCommon): BrowserRegistrationDescriptionParameters
- description
- BrowserRegistrationDescriptionCommon
A partial Web Push registration description.
Returns
A created Web Push registration description.
createBrowserTemplateRegistrationDescription(BrowserTemplateRegistrationDescriptionCommon)
Creates a Web Push registration description.
function createBrowserTemplateRegistrationDescription(description: BrowserTemplateRegistrationDescriptionCommon): BrowserTemplateRegistrationDescriptionParameters
- description
- BrowserTemplateRegistrationDescriptionCommon
A partial Web Push template registration description.
Returns
A created Web Push template registration description.
createFcmLegacyInstallation(DeviceTokenInstallation)
Creates a Firebase legacy HTTP based installation.
function createFcmLegacyInstallation(installation: DeviceTokenInstallation): FcmLegacyInstallationParameters
- installation
- DeviceTokenInstallation
A partial installation used to create the Firebase Legacy HTTP installation.
Returns
The newly created Baidu installation.
createFcmLegacyNotification(FcmLegacyNotificationParams)
Creates a notification to send to Firebase.
function createFcmLegacyNotification(notification: FcmLegacyNotificationParams): FcmLegacyNotificationParameters
- notification
- FcmLegacyNotificationParams
A partial message used to create a message for Firebase.
Returns
A newly created Firebase notification.
createFcmLegacyRegistrationDescription(GcmRegistrationDescriptionCommon)
Creates a Firebase Legacy registration description.
function createFcmLegacyRegistrationDescription(description: GcmRegistrationDescriptionCommon): GcmRegistrationDescriptionParameters
- description
- GcmRegistrationDescriptionCommon
A partial GCM registration description.
Returns
A created GCM registration description.
createFcmLegacyTemplateRegistrationDescription(GcmTemplateRegistrationDescriptionCommon)
Creates a GCM template registration description.
function createFcmLegacyTemplateRegistrationDescription(description: GcmTemplateRegistrationDescriptionCommon): GcmTemplateRegistrationDescriptionParameters
- description
- GcmTemplateRegistrationDescriptionCommon
A partial GCM template registration description.
Returns
A created GCM template registration description.
createFcmV1Installation(DeviceTokenInstallation)
Creates an Firebase V1 Cloud Messaging based installation.
function createFcmV1Installation(installation: DeviceTokenInstallation): FcmV1InstallationParameters
- installation
- DeviceTokenInstallation
A partial installation used to create the Firebase V1 Cloud Messaging installation.
Returns
The newly created Firebase V1 Cloud Messaging installation.
createFcmV1Notification(FcmV1NotificationParams)
Creates a notification to send to Firebase.
function createFcmV1Notification(notification: FcmV1NotificationParams): FcmV1NotificationParameters
- notification
- FcmV1NotificationParams
A partial message used to create a message for Firebase.
Returns
A newly created Firebase notification.
createFcmV1RegistrationDescription(FcmV1RegistrationDescriptionCommon)
Creates a Firebase V1 registration description.
function createFcmV1RegistrationDescription(description: FcmV1RegistrationDescriptionCommon): FcmV1RegistrationDescriptionParameters
- description
- FcmV1RegistrationDescriptionCommon
A partial FCM V1 registration description.
Returns
A created FCM V1 registration description.
createFcmV1TemplateRegistrationDescription(FcmV1TemplateRegistrationDescriptionCommon)
Creates a FCM V1 template registration description.
function createFcmV1TemplateRegistrationDescription(description: FcmV1TemplateRegistrationDescriptionCommon): FcmV1TemplateRegistrationDescriptionParameters
- description
- FcmV1TemplateRegistrationDescriptionCommon
A partial FCM V1 template registration description.
Returns
A created FCM V1 template registration description.
createFirebaseLegacyNotificationBody(FirebaseLegacyNativeMessage)
Creates a FcmLegacyNotification from a native Firebase payload.
function createFirebaseLegacyNotificationBody(nativeMessage: FirebaseLegacyNativeMessage): stringParameters
- nativeMessage
- FirebaseLegacyNativeMessage
The native message payload to send to Notification Hubs.
Returns
string
The JSON body to send to Notification Hubs.
createFirebaseV1NotificationBody(FirebaseV1NativeMessageEnvelope)
Creates a FcmV1Notification from a native Firebase payload.
function createFirebaseV1NotificationBody(nativeMessage: FirebaseV1NativeMessageEnvelope): stringParameters
- nativeMessage
- FirebaseV1NativeMessageEnvelope
The native message payload to send to Notification Hubs.
Returns
string
The JSON body to send to Notification Hubs.
createTagExpression(string[])
Creates a tag expression from a list of tags as a || expression.
function createTagExpression(tags: string[]): stringParameters
- tags
-
string[]
The tags to create the || expression
Returns
string
The tag expression made from the array of strings into an || expression.
createTemplateNotification(NotificationCommonParams)
Creates a template notification.
function createTemplateNotification(notification: NotificationCommonParams): TemplateNotificationParameters
- notification
- NotificationCommonParams
A partial message used to be used for a template notification.
Returns
A newly created Firebase.
createWindowsBadgeNotification(WnsNotificationParams)
Creates a badge message to send to WNS.
function createWindowsBadgeNotification(notification: WnsNotificationParams): WindowsNotificationParameters
- notification
- WnsNotificationParams
A partial message used to create a badge message for WNS.
Returns
A newly created WNS badge.
createWindowsBadgeNotificationBody(WindowsBadgeNativeMessage)
Builds a WindowsNotification from a Windows Badge.
function createWindowsBadgeNotificationBody(nativeMessage: WindowsBadgeNativeMessage): stringParameters
- nativeMessage
- WindowsBadgeNativeMessage
The Windows Badge Message to build.
Returns
string
The WNS XML created with the badge information.
createWindowsInstallation(DeviceTokenInstallation)
Creates a Windows Notification Services (WNS) based installation.
function createWindowsInstallation(installation: DeviceTokenInstallation): WindowsInstallationParameters
- installation
- DeviceTokenInstallation
A partial installation used to create the WNS installation.
Returns
The newly created WNS installation.
createWindowsNotification(WnsNotificationParams)
Creates a notification to send to WNS.
function createWindowsNotification(notification: WnsNotificationParams): WindowsNotificationParameters
- notification
- WnsNotificationParams
The WNS notification to send.
Returns
A newly created WNS message.
createWindowsRawNotification(WnsNotificationParams)
Creates a notification to send to WNS in wns/raw format..
function createWindowsRawNotification(notification: WnsNotificationParams): WindowsNotificationParameters
- notification
- WnsNotificationParams
A partial message used to create a message for WNS in XML format.
Returns
A newly created WNS message using XML.
createWindowsRegistrationDescription(WindowsRegistrationDescriptionCommon)
Creates a Windows registration description.
function createWindowsRegistrationDescription(description: WindowsRegistrationDescriptionCommon): WindowsRegistrationDescriptionParameters
- description
- WindowsRegistrationDescriptionCommon
A partial Windows registration description.
Returns
A created Windows registration description.
createWindowsTemplateRegistrationDescription(WindowsTemplateRegistrationDescriptionCommon)
Creates a Windows template registration description.
function createWindowsTemplateRegistrationDescription(description: WindowsTemplateRegistrationDescriptionCommon): WindowsTemplateRegistrationDescriptionParameters
- description
- WindowsTemplateRegistrationDescriptionCommon
A partial Windows template registration description.
Returns
A created Windows template registration description.
createWindowsTileNotification(WnsNotificationParams)
Creates a tile message to send to WNS.
function createWindowsTileNotification(notification: WnsNotificationParams): WindowsNotificationParameters
- notification
- WnsNotificationParams
A partial message used to create a tile message for WNS.
Returns
A newly created WNS tile.
createWindowsToastNotification(WnsNotificationParams)
Creates a toast message to send to WNS.
function createWindowsToastNotification(notification: WnsNotificationParams): WindowsNotificationParameters
- notification
- WnsNotificationParams
A partial message used to create a toast message for WNS.
Returns
A newly created WNS toast.
createXiaomiInstallation(DeviceTokenInstallation)
Creates a Xiaomi based installation.
function createXiaomiInstallation(installation: DeviceTokenInstallation): XiaomiInstallationParameters
- installation
- DeviceTokenInstallation
A partial installation used to create the Xiaomi installation.
Returns
The newly created Xiaomi installation.
createXiaomiNotification(NotificationCommonParams)
Creates a notification to send to Xiaomi.
function createXiaomiNotification(notification: NotificationCommonParams): XiaomiNotificationParameters
- notification
- NotificationCommonParams
A partial message used to create a message for Xiaomi.
Returns
A newly created Xiaomi notification.
createXiaomiRegistrationDescription(XiaomiRegistrationDescriptionCommon)
Creates a Xiaomi registration description.
function createXiaomiRegistrationDescription(description: XiaomiRegistrationDescriptionCommon): XiaomiRegistrationDescriptionParameters
- description
- XiaomiRegistrationDescriptionCommon
A partial Xiaomi registration description.
Returns
A created Xiaomi registration description.
createXiaomiTemplateRegistrationDescription(XiaomiTemplateRegistrationDescriptionCommon)
Creates a Xiaomi template registration description.
function createXiaomiTemplateRegistrationDescription(description: XiaomiTemplateRegistrationDescriptionCommon): XiaomiTemplateRegistrationDescriptionParameters
- description
- XiaomiTemplateRegistrationDescriptionCommon
A partial Xiaomi template registration description.
Returns
A created Xiaomi template registration description.