@azure/notification-hubs package
Classes
| NotificationHubsClient |
Isso representa um cliente para os Hubs de Notificação do Azure gerenciarem instalações e enviarem mensagens para dispositivos. |
Interfaces
| AdmInstallation |
Representa uma instalação baseada em ADM (Sistema de Mensagens de Dispositivo) da Amazon. |
| AdmNativeMessage |
Representa um conteúdo de mensagem de notificação do ADM nativo. |
| AdmNativeNotification |
Descreve mensagens de notificação do ADM. |
| AdmNotification |
Representa uma notificação por push do ADM (Sistema de Mensagens de Dispositivo) da Amazon. |
| AdmNotificationParams |
Representa uma notificação do ADM que pode ser enviada a um dispositivo. |
| AdmRegistrationChannel |
Descreve uma consulta de canal de registro do ADM. |
| AdmRegistrationDescription |
Representa a descrição do registro do ADM (Sistema de Mensagens de Dispositivo) da Amazon. |
| AdmRegistrationDescriptionCommon |
Representa uma descrição de registro. |
| AdmTemplateRegistrationDescription |
Representa a descrição do registro de modelo do ADM (Sistema de Mensagens de Dispositivo) da Amazon. |
| AdmTemplateRegistrationDescriptionCommon |
Representa a descrição do registro de modelo do ADM (Sistema de Mensagens de Dispositivo) da Amazon. |
| AppleAlert |
Representa o que está no corpo do alerta de APNs. |
| AppleApsNativeMessage |
Representa uma mensagem APS de APNs nativa. |
| AppleCriticalSound |
Representa um som crítico de APNs |
| AppleHeaders |
A lista de cabeçalhos específicos de APNs. |
| AppleInstallation |
Representa uma instalação baseada em APNs da Apple. |
| AppleNativeMessage |
Representa uma mensagem APNs nativa. |
| AppleNotification |
Representa uma notificação por push de APNs da Apple. |
| AppleNotificationParams |
Representa uma notificação da Apple que pode ser enviada a um dispositivo. |
| AppleRegistrationChannel |
Descreve uma consulta do canal de registro da Apple. |
| AppleRegistrationDescription |
Representa a descrição do registro da Apple. |
| AppleRegistrationDescriptionCommon |
Representa a descrição do registro da Apple. |
| AppleTemplateRegistrationDescription |
Representa a descrição do registro de modelo da Apple. |
| AppleTemplateRegistrationDescriptionCommon |
Representa a descrição do registro de modelo da Apple. |
| BaiduAppleNativePayload |
Representa o conteúdo nativo da Baidu Apple. |
| BaiduInstallation |
Representa uma instalação baseada em Baidu. |
| BaiduNativeMessage |
Formato nativo do Baidu: https://stackoverflow.com/questions/42591815/customize-baidu-push-json-payloadhttp://www.tuicool.com/articles/ZnmANn |
| BaiduNotification |
Representa uma notificação por push do Baidu. |
| BaiduRegistrationChannel |
Descreve uma consulta de canal de Registro do Baidu. |
| BaiduRegistrationDescription |
Representa uma descrição de registro do Baidu. |
| BaiduRegistrationDescriptionCommon |
Representa uma descrição de registro. |
| BaiduTemplateRegistrationDescription |
Representa uma descrição de registro de modelo baidu. |
| BaiduTemplateRegistrationDescriptionCommon |
Representa uma descrição de registro de modelo baidu. |
| BroadcastSendNotificationOptions |
Opções para enviar notificações para envio de teste. |
| BrowserInstallation |
Representa uma instalação baseada em Navegador/Web Push. |
| BrowserInstallationCommon |
Representa uma instalação baseada em Navegador/Web Push. |
| BrowserNotification |
Representa uma notificação por push do Navegador. |
| BrowserPushChannel |
Representa o canal push para uma instalação do Browser Push. |
| BrowserRegistrationChannel |
Descreve uma consulta de canal de registro do navegador. |
| BrowserRegistrationDescription |
Representa uma descrição de registro por push do navegador. |
| BrowserRegistrationDescriptionCommon |
Representa uma descrição de registro por push do navegador. |
| BrowserTemplateRegistrationDescription |
Representa uma descrição de registro remplata por push do navegador. |
| BrowserTemplateRegistrationDescriptionCommon |
Representa uma descrição de registro remplata por push do navegador. |
| DeviceTokenInstallation |
Representa uma instalação com um token de dispositivo baseado em cadeia de caracteres. |
| DirectSendNotificationOptions |
Opções para enviar notificações para dispositivos individuais. |
| EntityOperationOptions |
Representa as opções de operação de atualização de entidade que podem ser definidas. |
| FcmLegacyInstallation |
Representa uma instalação HTTP herdada do Firebase. |
| FcmLegacyNotification |
Representa uma notificação por push HTTP herdada do Firebase. |
| FcmLegacyNotificationParams |
Representa uma notificação herdada do Firebase que pode ser enviada para um dispositivo. |
| FcmV1Installation |
Representa uma instalação baseada em Mensagens de Nuvem do Firebase V1. |
| FcmV1Notification |
Representa uma notificação da API do Firebase V1 que pode ser enviada para um dispositivo. |
| FcmV1NotificationParams |
Representa uma notificação do Firebase V1 que pode ser enviada para um dispositivo. |
| FcmV1RegistrationDescription |
Representa a descrição do registro do Hub de Notificação para o Google Cloud Messaging. |
| FcmV1RegistrationDescriptionCommon |
Representa a descrição do registro do Hub de Notificação para o Google Cloud Messaging. |
| FcmV1TemplateRegistrationDescription |
Representa a descrição do registro de modelo do Hub de Notificação para o Firebase V1 Cloud Messaging. |
| FcmV1TemplateRegistrationDescriptionCommon |
Representa a descrição do registro de modelo do Hub de Notificação para o Firebase V1 Cloud Messaging. |
| FirebaseLegacyAndroidNativePayload |
Representa um conteúdo nativo do Android para a interface HTTP herdada do Firebase. |
| FirebaseLegacyAppleNativePayload |
Representa uma carga nativa de APNs para a interface HTTP herdada do Firebase. |
| FirebaseLegacyNativeMessage |
Representa os destinos, as opções e o conteúdo das mensagens JSON HTTP para a interface HTTP herdada do Firebase. |
| FirebaseLegacyRegistrationChannel |
Descreve uma consulta de canal de registro herdado do Firebase. |
| FirebaseLegacyWebNativePayload |
Representa um conteúdo nativo do Web Push para a interface HTTP herdada do Firebase. |
| FirebaseV1AndroidConfig |
Opções específicas do Android para mensagens enviadas por meio do servidor de conexão FCM. |
| FirebaseV1AndroidFcmOptions |
Opções para recursos fornecidos pelo SDK da FCM para Android. |
| FirebaseV1AndroidNotification |
Notificação para enviar para dispositivos Android. |
| FirebaseV1ApnsConfig |
Opções específicas do Serviço de Notificação por Push da Apple. |
| FirebaseV1ApnsFcmOptions |
Opções de recursos fornecidos pelo SDK da FCM para iOS. |
| FirebaseV1FcmOptions | |
| FirebaseV1NativeMessage |
Representa os destinos, as opções e o conteúdo das mensagens JSON HTTP para a interface do Firebase V1. |
| FirebaseV1NativeMessageEnvelope |
Representa o envelope de mensagem nativa do Firebase V1. |
| FirebaseV1NativeNotification |
Representa um conteúdo de mensagem de notificação da FCM V1 nativa. |
| FirebaseV1RegistrationChannel |
Descreve uma consulta de canal de registro herdado do Firebase. |
| FirebaseV1WebPushConfig | |
| FirebaseV1WebPushFcmOptions |
Opções de recursos fornecidos pelo SDK da FCM para Web. |
| FirebaseV1WebPushNotification |
Representa um conteúdo de notificação por push da Web. |
| GcmRegistrationDescription |
Representa a descrição do registro do Hub de Notificação para o Google Cloud Messaging. |
| GcmRegistrationDescriptionCommon |
Representa a descrição do registro do Hub de Notificação para o Google Cloud Messaging. |
| GcmTemplateRegistrationDescription |
Representa a descrição do registro de modelo do Hub de Notificação para o Firebase Legacy Cloud Messaging. |
| GcmTemplateRegistrationDescriptionCommon |
Representa a descrição do registro de modelo do Hub de Notificação para o Firebase Legacy Cloud Messaging. |
| InstallationCommon |
Representa uma instalação para um dispositivo para Hubs de Notificação. |
| InstallationTemplate |
Representa um modelo de instalação. |
| JsonNotification |
Representa um hub de notificação JSON. |
| JsonPatch |
Representa uma operação de patch. |
| MpnsRegistrationDescription |
Representa uma descrição de registro dos Serviços de Notificação do Windows Phone. |
| MpnsRegistrationDescriptionCommon |
Representa uma descrição de registro dos Serviços de Notificação do Windows Phone. |
| MpnsTemplateRegistrationDescription |
Representa um registro de modelo dos Serviços de Notificação do Windows Phone. |
| MpnsTemplateRegistrationDescriptionCommon |
Representa um registro de modelo dos Serviços de Notificação do Windows Phone. |
| NotificationCommon |
Representa uma notificação que pode ser enviada a um dispositivo. |
| NotificationCommonParams |
Os parâmetros de notificação comuns para aceitar um corpo de cadeia de caracteres ou um corpo JSON. |
| NotificationDetails |
Representa os detalhes da notificação. |
| NotificationHubJob |
Representa um trabalho do Hub de Notificação. |
| NotificationHubsClientOptions |
Descreve as opções que podem ser fornecidas durante a criação do NotificationHubsClientContext. |
| NotificationHubsMessageResponse |
Descreve uma resposta do serviço Hubs de Notificação para operações de envio. |
| NotificationHubsResponse |
Descreve uma resposta dos Hubs de Notificação que inclui uma ID de acompanhamento, ID de correlação e localização. |
| NotificationOutcome |
A contagem por plataforma por estado. |
| PolledOperationOptions |
Opções para operações pesquisadas, incluindo o ciclo de intervalo de sondagem. |
| RegistrationDescriptionCommon |
Representa uma descrição de registro. |
| RegistrationQueryLimitOptions |
Representa as opções de consulta para incluir $top suporte. |
| RegistrationQueryOptions |
Representa as opções de consulta para incluir $top e $filter. |
| RegistrationQueryResponse |
Descreve uma resposta de consulta de registro com registros e um token de continuação. |
| RegistrationResult |
Representa o resultado do registro. |
| ScheduleNotificationOptions |
Opções para enviar notificações para o envio agendado baseado em marca. |
| SendNotificationOptions |
Opções para enviar notificações para envio baseado em marca. |
| TemplateNotification |
Representa uma notificação por push baseada em modelo. |
| TemplateRegistrationDescription |
Representa a descrição de um registro de modelo. |
| WindowsBadgeNativeMessage |
Representa a mensagem de selo do Windows |
| WindowsHeaders |
Lista de cabeçalhos específicos do WNS. |
| WindowsInstallation |
Representa uma instalação baseada em WNS (Serviços de Notificação do Windows). |
| WindowsNotification |
Representa uma notificação por push dos Serviços de Notificação do Windows (WNS). |
| WindowsRegistrationChannel |
Descreve uma consulta de canal de registro dos Serviços de Notificação do Windows. |
| WindowsRegistrationDescription |
Representa uma descrição de registro do WNS (Serviços de Notificação do Windows). |
| WindowsRegistrationDescriptionCommon |
Representa uma descrição de registro do WNS (Serviços de Notificação do Windows). |
| WindowsTemplateRegistrationDescription |
Representa um registro de modelo do WNS (Serviços de Notificação do Windows). |
| WindowsTemplateRegistrationDescriptionCommon |
Representa um registro de modelo do WNS (Serviços de Notificação do Windows). |
| WnsNotificationParams |
Representa uma notificação WNS que pode ser enviada a um dispositivo. |
| XiaomiInstallation |
Representa uma instalação baseada na Xiaomi. |
| XiaomiNotification |
Representa uma notificação por push da Xiaomi. |
| XiaomiRegistrationChannel |
Descreve uma consulta de canal de registro da Xiaomi. |
| XiaomiRegistrationDescription |
Representa uma descrição de registro da Xiaomi. |
| XiaomiRegistrationDescriptionCommon |
Representa uma descrição de registro da Xiaomi. |
| XiaomiTemplateRegistrationDescription |
Representa um registro de modelo do WNS (Serviços de Notificação do Windows). |
| XiaomiTemplateRegistrationDescriptionCommon |
Representa um registro de modelo da Xiaomi. |
Aliases de tipo
| ApnsPushTypes |
Descreve os tipos de push de APNs. |
| Installation |
Representa os tipos de instalações disponíveis nos Hubs de Notificação. |
| JsonPatchOperation |
Representa os tipos de patch JSON de adicionar, remover e substituir. |
| Notification |
Representa os possíveis tipos de mensagens de notificação por push. |
| NotificationHubJobPoller |
Descreve um poller para tipos NotificationHubJob. |
| NotificationHubJobStatus |
Descreve os tipos de status de trabalho do hub de notificação. |
| NotificationHubJobType |
Descreve os tipos de trabalhos do hub de notificação. |
| NotificationOutcomeState |
Representa os estados de resultado da notificação. |
| PushHandle |
Representa os tipos de canais por push disponíveis para Hubs de Notificação. |
| RegistrationChannel |
Descreve uma consulta de registro. |
| RegistrationDescription |
Descreve os tipos de descrições de registro. |
| RegistrationType |
Representa os tipos de descrições de registro. |
| WindowsBadgeGlyphType |
Representa os tipos de glifos de selo do Windows |
| WindowsContentType |
Representa os possíveis tipos de conteúdo WNS. |
| WnsTypes |
A lista de tipos específicos do WNS. |
Funções
Variáveis
| Rest |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
Detalhes da função
createAdmInstallation(DeviceTokenInstallation)
Cria uma instalação baseada em ADM (Sistema de Mensagens de Dispositivo) da Amazon.
function createAdmInstallation(installation: DeviceTokenInstallation): AdmInstallationParâmetros
- installation
- DeviceTokenInstallation
Uma instalação parcial usada para criar a instalação do ADM.
Retornos
A instalação do ADM recém-criada.
createAdmNotification(AdmNotificationParams)
Cria uma notificação para enviar para um dispositivo amazon device messaging.
function createAdmNotification(notification: AdmNotificationParams): AdmNotificationParâmetros
- notification
- AdmNotificationParams
Uma mensagem parcial usada para criar uma mensagem para o Amazon Device Messaging.
Retornos
Um Amazon Device Messaging recém-criado.
createAdmNotificationBody(AdmNativeMessage)
Cria um AdmNotification com base em uma carga nativa do ADM.
function createAdmNotificationBody(nativeMessage: AdmNativeMessage): stringParâmetros
- nativeMessage
- AdmNativeMessage
O conteúdo da mensagem nativa a ser enviada aos Hubs de Notificação.
Retornos
string
O AdmNotification a ser enviado aos Hubs de Notificação.
createAdmRegistrationDescription(AdmRegistrationDescriptionCommon)
Cria uma descrição de registro do ADM.
function createAdmRegistrationDescription(description: AdmRegistrationDescriptionCommon): AdmRegistrationDescriptionParâmetros
- description
- AdmRegistrationDescriptionCommon
Uma descrição parcial do registro do ADM.
Retornos
Uma descrição de registro do ADM criada.
createAdmTemplateRegistrationDescription(AdmTemplateRegistrationDescriptionCommon)
Cria uma descrição de registro de modelo do ADM.
function createAdmTemplateRegistrationDescription(description: AdmTemplateRegistrationDescriptionCommon): AdmTemplateRegistrationDescriptionParâmetros
- description
- AdmTemplateRegistrationDescriptionCommon
Uma descrição parcial do registro de modelo do ADM.
Retornos
Uma descrição de registro de modelo do ADM criada.
createAppleInstallation(DeviceTokenInstallation)
Cria uma instalação baseada na Apple.
function createAppleInstallation(installation: DeviceTokenInstallation): AppleInstallationParâmetros
- installation
- DeviceTokenInstallation
Uma instalação parcial usada para criar a instalação da Apple.
Retornos
A instalação recém-criada da Apple.
createAppleNotification(AppleNotificationParams)
Cria uma notificação para enviar para um dispositivo Apple.
function createAppleNotification(notification: AppleNotificationParams): AppleNotificationParâmetros
- notification
- AppleNotificationParams
Uma mensagem parcial usada para criar uma mensagem para a Apple.
Retornos
Uma Apple recém-criada.
createAppleNotificationBody(AppleNativeMessage)
Cria uma mensagem nativa de APNs para enviar aos Hubs de Notificação.
function createAppleNotificationBody(nativeMessage: AppleNativeMessage): stringParâmetros
- nativeMessage
- AppleNativeMessage
As propriedades de mensagem nativa da Apple a serem definidas.
Retornos
string
Um AppleNotification para enviar aos Hubs de Notificação.
createAppleRegistrationDescription(AppleRegistrationDescriptionCommon)
Cria uma descrição de registro da Apple.
function createAppleRegistrationDescription(description: AppleRegistrationDescriptionCommon): AppleRegistrationDescriptionParâmetros
- description
- AppleRegistrationDescriptionCommon
Uma descrição parcial do registro da Apple.
Retornos
Uma descrição de registro da Apple criada.
createAppleTemplateRegistrationDescription(AppleTemplateRegistrationDescriptionCommon)
Cria uma descrição de registro de modelo da Apple.
function createAppleTemplateRegistrationDescription(description: AppleTemplateRegistrationDescriptionCommon): AppleTemplateRegistrationDescriptionParâmetros
- description
- AppleTemplateRegistrationDescriptionCommon
Uma descrição parcial do registro de modelo da Apple.
Retornos
Uma descrição de registro de modelo da Apple criada.
createBaiduInstallation(DeviceTokenInstallation)
Cria uma instalação baseada em Baidu.
function createBaiduInstallation(installation: DeviceTokenInstallation): BaiduInstallationParâmetros
- installation
- DeviceTokenInstallation
Uma instalação parcial usada para criar a instalação do Baidu.
Retornos
A instalação recém-criada do Baidu.
createBaiduNotification(NotificationCommonParams)
Cria uma notificação para enviar para um dispositivo registrado do Baidu.
function createBaiduNotification(notification: NotificationCommonParams): BaiduNotificationParâmetros
- notification
- NotificationCommonParams
Uma mensagem parcial usada para criar uma mensagem para Baidu.
Retornos
Um Baidu recém-criado.
createBaiduNotificationBody(BaiduNativeMessage)
Cria uma BaiduNotification com base em uma carga nativa do Baidu.
function createBaiduNotificationBody(nativeMessage: BaiduNativeMessage): stringParâmetros
- nativeMessage
- BaiduNativeMessage
O conteúdo da mensagem nativa a ser enviada aos Hubs de Notificação.
Retornos
string
O corpo JSON a ser enviado aos Hubs de Notificação.
createBaiduRegistrationDescription(BaiduRegistrationDescriptionCommon)
Cria uma descrição de registro do Baidu.
function createBaiduRegistrationDescription(description: BaiduRegistrationDescriptionCommon): BaiduRegistrationDescriptionParâmetros
- description
- BaiduRegistrationDescriptionCommon
Uma descrição parcial do registro do Baidu.
Retornos
Uma descrição de registro do Baidu criada.
createBaiduTemplateRegistrationDescription(BaiduTemplateRegistrationDescriptionCommon)
Cria uma descrição de registro de modelo baidu.
function createBaiduTemplateRegistrationDescription(description: BaiduTemplateRegistrationDescriptionCommon): BaiduTemplateRegistrationDescriptionParâmetros
- description
- BaiduTemplateRegistrationDescriptionCommon
Uma descrição parcial do registro do modelo baidu.
Retornos
Uma descrição de registro de modelo do Baidu criada.
createBrowserInstallation(BrowserInstallationCommon)
Cria uma instalação baseada em Push da Web.
function createBrowserInstallation(installation: BrowserInstallationCommon): BrowserInstallationParâmetros
- installation
- BrowserInstallationCommon
Uma instalação parcial usada para criar a instalação do Web Push.
Retornos
A instalação do Web Push recém-criada.
createBrowserNotification(NotificationCommonParams)
Cria uma notificação para enviar para um navegador.
function createBrowserNotification(notification: NotificationCommonParams): BrowserNotificationParâmetros
- notification
- NotificationCommonParams
Uma mensagem parcial usada para criar uma mensagem para um navegador.
Retornos
Um navegador web push recém-criado.
createBrowserRegistrationDescription(BrowserRegistrationDescriptionCommon)
Cria uma descrição de registro por push da Web.
function createBrowserRegistrationDescription(description: BrowserRegistrationDescriptionCommon): BrowserRegistrationDescriptionParâmetros
- description
- BrowserRegistrationDescriptionCommon
Uma descrição parcial do registro do Web Push.
Retornos
Uma descrição de registro do Web Push criada.
createBrowserTemplateRegistrationDescription(BrowserTemplateRegistrationDescriptionCommon)
Cria uma descrição de registro por push da Web.
function createBrowserTemplateRegistrationDescription(description: BrowserTemplateRegistrationDescriptionCommon): BrowserTemplateRegistrationDescriptionParâmetros
- description
- BrowserTemplateRegistrationDescriptionCommon
Uma descrição parcial do registro de modelo do Web Push.
Retornos
Uma descrição de registro de modelo do Web Push criada.
createFcmLegacyInstallation(DeviceTokenInstallation)
Cria uma instalação baseada em HTTP herdada do Firebase.
function createFcmLegacyInstallation(installation: DeviceTokenInstallation): FcmLegacyInstallationParâmetros
- installation
- DeviceTokenInstallation
Uma instalação parcial usada para criar a instalação HTTP herdada do Firebase.
Retornos
A instalação recém-criada do Baidu.
createFcmLegacyNotification(FcmLegacyNotificationParams)
Cria uma notificação para enviar ao Firebase.
function createFcmLegacyNotification(notification: FcmLegacyNotificationParams): FcmLegacyNotificationParâmetros
- notification
- FcmLegacyNotificationParams
Uma mensagem parcial usada para criar uma mensagem para o Firebase.
Retornos
Uma notificação do Firebase recém-criada.
createFcmLegacyRegistrationDescription(GcmRegistrationDescriptionCommon)
Cria uma descrição de registro do Firebase Legacy.
function createFcmLegacyRegistrationDescription(description: GcmRegistrationDescriptionCommon): GcmRegistrationDescriptionParâmetros
- description
- GcmRegistrationDescriptionCommon
Uma descrição parcial do registro GCM.
Retornos
Uma descrição de registro do GCM criada.
createFcmLegacyTemplateRegistrationDescription(GcmTemplateRegistrationDescriptionCommon)
Cria uma descrição de registro de modelo GCM.
function createFcmLegacyTemplateRegistrationDescription(description: GcmTemplateRegistrationDescriptionCommon): GcmTemplateRegistrationDescriptionParâmetros
- description
- GcmTemplateRegistrationDescriptionCommon
Uma descrição parcial do registro do modelo GCM.
Retornos
Uma descrição de registro de modelo do GCM criada.
createFcmV1Installation(DeviceTokenInstallation)
Cria uma instalação baseada em Mensagens de Nuvem do Firebase V1.
function createFcmV1Installation(installation: DeviceTokenInstallation): FcmV1InstallationParâmetros
- installation
- DeviceTokenInstallation
Uma instalação parcial usada para criar a instalação do Firebase V1 Cloud Messaging.
Retornos
A instalação do Firebase V1 Cloud Messaging recém-criada.
createFcmV1Notification(FcmV1NotificationParams)
Cria uma notificação para enviar ao Firebase.
function createFcmV1Notification(notification: FcmV1NotificationParams): FcmV1NotificationParâmetros
- notification
- FcmV1NotificationParams
Uma mensagem parcial usada para criar uma mensagem para o Firebase.
Retornos
Uma notificação do Firebase recém-criada.
createFcmV1RegistrationDescription(FcmV1RegistrationDescriptionCommon)
Cria uma descrição de registro do Firebase V1.
function createFcmV1RegistrationDescription(description: FcmV1RegistrationDescriptionCommon): FcmV1RegistrationDescriptionParâmetros
- description
- FcmV1RegistrationDescriptionCommon
Uma descrição parcial do registro da FCM V1.
Retornos
Uma descrição de registro da FCM V1 criada.
createFcmV1TemplateRegistrationDescription(FcmV1TemplateRegistrationDescriptionCommon)
Cria uma descrição de registro de modelo da FCM V1.
function createFcmV1TemplateRegistrationDescription(description: FcmV1TemplateRegistrationDescriptionCommon): FcmV1TemplateRegistrationDescriptionParâmetros
- description
- FcmV1TemplateRegistrationDescriptionCommon
Uma descrição parcial do registro de modelo da FCM V1.
Retornos
Uma descrição de registro de modelo da FCM V1 criada.
createFirebaseLegacyNotificationBody(FirebaseLegacyNativeMessage)
Cria uma FcmLegacyNotification de uma carga nativa do Firebase.
function createFirebaseLegacyNotificationBody(nativeMessage: FirebaseLegacyNativeMessage): stringParâmetros
- nativeMessage
- FirebaseLegacyNativeMessage
O conteúdo da mensagem nativa a ser enviada aos Hubs de Notificação.
Retornos
string
O corpo JSON a ser enviado aos Hubs de Notificação.
createFirebaseV1NotificationBody(FirebaseV1NativeMessageEnvelope)
Cria uma FcmV1Notification de uma carga nativa do Firebase.
function createFirebaseV1NotificationBody(nativeMessage: FirebaseV1NativeMessageEnvelope): stringParâmetros
- nativeMessage
- FirebaseV1NativeMessageEnvelope
O conteúdo da mensagem nativa a ser enviada aos Hubs de Notificação.
Retornos
string
O corpo JSON a ser enviado aos Hubs de Notificação.
createTagExpression(string[])
Cria uma expressão de marca de uma lista de marcas como || expressão.
function createTagExpression(tags: string[]): stringParâmetros
- tags
-
string[]
As marcas para criar o || expressão
Retornos
string
A expressão de marca feita da matriz de cadeias de caracteres em um || expressão.
createTemplateNotification(NotificationCommonParams)
Cria uma notificação de modelo.
function createTemplateNotification(notification: NotificationCommonParams): TemplateNotificationParâmetros
- notification
- NotificationCommonParams
Uma mensagem parcial costumava ser usada para uma notificação de modelo.
Retornos
Um Firebase recém-criado.
createWindowsBadgeNotification(WnsNotificationParams)
Cria uma mensagem de selo para enviar ao WNS.
function createWindowsBadgeNotification(notification: WnsNotificationParams): WindowsNotificationParâmetros
- notification
- WnsNotificationParams
Uma mensagem parcial usada para criar uma mensagem de selo para WNS.
Retornos
Um selo WNS recém-criado.
createWindowsBadgeNotificationBody(WindowsBadgeNativeMessage)
Cria um WindowsNotification com base em um Selo do Windows.
function createWindowsBadgeNotificationBody(nativeMessage: WindowsBadgeNativeMessage): stringParâmetros
- nativeMessage
- WindowsBadgeNativeMessage
A Mensagem de Selo do Windows a ser compilada.
Retornos
string
O XML do WNS criado com as informações de selo.
createWindowsInstallation(DeviceTokenInstallation)
Cria uma instalação baseada em WNS (Serviços de Notificação do Windows).
function createWindowsInstallation(installation: DeviceTokenInstallation): WindowsInstallationParâmetros
- installation
- DeviceTokenInstallation
Uma instalação parcial usada para criar a instalação do WNS.
Retornos
A instalação do WNS recém-criada.
createWindowsNotification(WnsNotificationParams)
Cria uma notificação para enviar ao WNS.
function createWindowsNotification(notification: WnsNotificationParams): WindowsNotificationParâmetros
- notification
- WnsNotificationParams
A notificação do WNS a ser enviada.
Retornos
Uma mensagem WNS recém-criada.
createWindowsRawNotification(WnsNotificationParams)
Cria uma notificação para enviar ao WNS no formato wns/raw..
function createWindowsRawNotification(notification: WnsNotificationParams): WindowsNotificationParâmetros
- notification
- WnsNotificationParams
Uma mensagem parcial usada para criar uma mensagem para WNS no formato XML.
Retornos
Uma mensagem WNS recém-criada usando XML.
createWindowsRegistrationDescription(WindowsRegistrationDescriptionCommon)
Cria uma descrição de registro do Windows.
function createWindowsRegistrationDescription(description: WindowsRegistrationDescriptionCommon): WindowsRegistrationDescriptionParâmetros
- description
- WindowsRegistrationDescriptionCommon
Uma descrição parcial do registro do Windows.
Retornos
Uma descrição de registro do Windows criada.
createWindowsTemplateRegistrationDescription(WindowsTemplateRegistrationDescriptionCommon)
Cria uma descrição de registro de modelo do Windows.
function createWindowsTemplateRegistrationDescription(description: WindowsTemplateRegistrationDescriptionCommon): WindowsTemplateRegistrationDescriptionParâmetros
- description
- WindowsTemplateRegistrationDescriptionCommon
Uma descrição parcial do registro de modelo do Windows.
Retornos
Uma descrição de registro de modelo do Windows criada.
createWindowsTileNotification(WnsNotificationParams)
Cria uma mensagem de bloco para enviar ao WNS.
function createWindowsTileNotification(notification: WnsNotificationParams): WindowsNotificationParâmetros
- notification
- WnsNotificationParams
Uma mensagem parcial usada para criar uma mensagem de bloco para WNS.
Retornos
Um bloco WNS recém-criado.
createWindowsToastNotification(WnsNotificationParams)
Cria uma mensagem do sistema para enviar ao WNS.
function createWindowsToastNotification(notification: WnsNotificationParams): WindowsNotificationParâmetros
- notification
- WnsNotificationParams
Uma mensagem parcial usada para criar uma mensagem do sistema para WNS.
Retornos
Um sistema WNS recém-criado.
createXiaomiInstallation(DeviceTokenInstallation)
Cria uma instalação baseada na Xiaomi.
function createXiaomiInstallation(installation: DeviceTokenInstallation): XiaomiInstallationParâmetros
- installation
- DeviceTokenInstallation
Uma instalação parcial usada para criar a instalação da Xiaomi.
Retornos
A instalação recém-criada da Xiaomi.
createXiaomiNotification(NotificationCommonParams)
Cria uma notificação para enviar à Xiaomi.
function createXiaomiNotification(notification: NotificationCommonParams): XiaomiNotificationParâmetros
- notification
- NotificationCommonParams
Uma mensagem parcial usada para criar uma mensagem para a Xiaomi.
Retornos
Uma notificação da Xiaomi recém-criada.
createXiaomiRegistrationDescription(XiaomiRegistrationDescriptionCommon)
Cria uma descrição de registro da Xiaomi.
function createXiaomiRegistrationDescription(description: XiaomiRegistrationDescriptionCommon): XiaomiRegistrationDescriptionParâmetros
- description
- XiaomiRegistrationDescriptionCommon
Uma descrição parcial do registro da Xiaomi.
Retornos
Uma descrição de registro da Xiaomi criada.
createXiaomiTemplateRegistrationDescription(XiaomiTemplateRegistrationDescriptionCommon)
Cria uma descrição de registro de modelo da Xiaomi.
function createXiaomiTemplateRegistrationDescription(description: XiaomiTemplateRegistrationDescriptionCommon): XiaomiTemplateRegistrationDescriptionParâmetros
- description
- XiaomiTemplateRegistrationDescriptionCommon
Uma descrição parcial do registro de modelo da Xiaomi.
Retornos
Uma descrição de registro de modelo da Xiaomi criada.
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): eParâmetros
- e
-
unknown
Algo pego por uma cláusula catch.
Retornos
e
Detalhes da variável
RestError
Um tipo de erro personalizado para solicitações de pipeline com falha.
RestError: RestErrorConstructor