NotificationHubsClient class
Dies stellt einen Client für Azure Notification Hubs dar, um Installationen zu verwalten und Nachrichten an Geräte zu senden.
Konstruktoren
| Notification |
Erstellt eine neue Instanz des NotificationClient mit einer Verbindungszeichenfolge, hubnamen und -optionen. |
Methoden
| begin |
Sendet einen Benachrichtigungshub-Auftrag und erstellt einen Poller zum Abrufen von Ergebnissen. |
| cancel |
Bricht die geplante Benachrichtigung mit der angegebenen Benachrichtigungs-ID ab. |
| create |
Erstellt oder überschreibt eine Installation in einen Benachrichtigungshub. |
| create |
Erstellt oder aktualisiert eine Registrierung. |
| create |
Erstellt eine neue Registrierung. Diese Methode generiert eine Registrierungs-ID, mit der Sie diese Registrierung anschließend abrufen, aktualisieren und löschen können. |
| create |
Erstellt eine neue Registrierungs-ID. |
| delete |
Löscht eine Installation aus einem Benachrichtigungshub. |
| delete |
Löscht eine Registrierung mit der angegebenen Registrierungs-ID. |
| get |
Ruft eine Azure Storage-Container-URL ab. Der Container enthält Feedbackdaten für den Benachrichtigungshub. Der Aufrufer kann dann das Azure Storage Services SDK verwenden, um den Inhalt des Containers abzurufen. |
| get |
Ruft eine Azure Notification Hub-Installation durch die Installations-ID ab. |
| get |
Ruft einen Benachrichtigungshubauftrag anhand der ID ab. |
| get |
Ruft die Ergebnisse eines Sendevorgangs ab. Dadurch können Zwischenergebnisse abgerufen werden, wenn das Senden verarbeitet wird, oder endgültige Ergebnisse, wenn das Senden* abgeschlossen ist. Diese API kann nur für Standard-SKU und höher aufgerufen werden. |
| get |
Ruft eine Registrierung durch die angegebene Registrierungs-ID ab. |
| list |
Ruft alle Benachrichtigungshubaufträge für diesen Benachrichtigungshub ab. |
| list |
Ruft alle Registrierungen für den Benachrichtigungshub mit den angegebenen Abfrageoptionen ab. |
| list |
Ruft alle Registrierungen für den Benachrichtigungshub mit den angegebenen Geräteinformationen und Optionen ab. |
| list |
Listet alle Registrierungen mit dem entsprechenden Tag auf. |
| schedule |
Plant eine Pushbenachrichtigung an alle Geräte zum angegebenen Zeitpunkt. HINWEIS: Dies ist nur in den Azure-Benachrichtigungshubs der Standard-SKU verfügbar. |
| schedule |
Plant eine Pushbenachrichtigung auf Geräten, die den angegebenen Tags oder Tagausdrücken zum angegebenen Zeitpunkt entsprechen. HINWEIS: Dies ist nur in den Azure-Benachrichtigungshubs der Standard-SKU verfügbar. |
| send |
Sendet Pushbenachrichtigungen an Geräte aller Geräte. |
| send |
Sendet Pushbenachrichtigungen an Geräte, die den angegebenen Tags oder Tagausdrücken entsprechen. |
| submit |
Sendet einen Benachrichtigungshubauftrag. Beachten Sie, dass dies für den Standard-SKU-Namespace und höher verfügbar ist. |
| update |
Aktualisiert eine Installation mithilfe des JSON-Patch Standards in RFC6902. |
| update |
Aktualisiert eine vorhandene Registrierung. |
Details zum Konstruktor
NotificationHubsClient(string, string, NotificationHubsClientOptions)
Erstellt eine neue Instanz des NotificationClient mit einer Verbindungszeichenfolge, hubnamen und -optionen.
new NotificationHubsClient(connectionString: string, hubName: string, options?: NotificationHubsClientOptions)Parameter
- connectionString
-
string
Die Verbindungszeichenfolge für die Zugriffsrichtlinie für den Benachrichtigungshub.
- hubName
-
string
Der Name des Azure Notification Hub.
- options
- NotificationHubsClientOptions
Optionen zum Konfigurieren des Azure Notification Hubs-Clients.
Details zur Methode
beginSubmitNotificationHubJob(NotificationHubJob, PolledOperationOptions)
Sendet einen Benachrichtigungshub-Auftrag und erstellt einen Poller zum Abrufen von Ergebnissen.
function beginSubmitNotificationHubJob(notificationHubJob: NotificationHubJob, options?: PolledOperationOptions): Promise<NotificationHubJobPoller>Parameter
- notificationHubJob
- NotificationHubJob
Der Import-/Exportauftrag des Benachrichtigungshubs, der gestartet werden soll.
- options
- PolledOperationOptions
Die Vorgangsoptionen.
Gibt zurück
Promise<NotificationHubJobPoller>
Ein Poller, der aufgerufen werden kann, um den Auftrag bis zum Abschluss des Auftrags abzufragen.
cancelScheduledNotification(string, OperationOptions)
Bricht die geplante Benachrichtigung mit der angegebenen Benachrichtigungs-ID ab.
function cancelScheduledNotification(notificationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>Parameter
- notificationId
-
string
Die Benachrichtigungs-ID aus der geplanten Benachrichtigung.
- options
- OperationOptions
Die Vorgangsoptionen.
Gibt zurück
Promise<NotificationHubsResponse>
Eine Benachrichtigungshubantwort mit Korrelations-ID und Tracking-ID.
createOrUpdateInstallation(Installation, OperationOptions)
Erstellt oder überschreibt eine Installation in einen Benachrichtigungshub.
function createOrUpdateInstallation(installation: Installation, options?: OperationOptions): Promise<NotificationHubsResponse>Parameter
- installation
- Installation
Die installation, die erstellt oder überschrieben werden soll.
- options
- OperationOptions
Konfigurationsoptionen für den Erstellungs- oder Updateinstallationsvorgang.
Gibt zurück
Promise<NotificationHubsResponse>
Eine NotificationHubResponse mit der Nachverfolgungs-ID, der Korrelations-ID und dem Standort.
createOrUpdateRegistration(RegistrationDescription, OperationOptions)
Erstellt oder aktualisiert eine Registrierung.
function createOrUpdateRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Parameter
- registration
- RegistrationDescription
Die Registrierung, die erstellt oder aktualisiert werden soll.
- options
- OperationOptions
Die Vorgangsoptionen.
Gibt zurück
Promise<RegistrationDescription>
Die erstellte oder aktualisierte Registrierungsbeschreibung.
createRegistration(RegistrationDescription, OperationOptions)
Erstellt eine neue Registrierung. Diese Methode generiert eine Registrierungs-ID, mit der Sie diese Registrierung anschließend abrufen, aktualisieren und löschen können.
function createRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Parameter
- registration
- RegistrationDescription
Die zu erstellende Registrierung.
- options
- OperationOptions
Optionen zum Erstellen einer neuen Registrierung.
Gibt zurück
Promise<RegistrationDescription>
Die neu erstellte Registrierungsbeschreibung.
createRegistrationId(OperationOptions)
Erstellt eine neue Registrierungs-ID.
function createRegistrationId(options?: OperationOptions): Promise<string>Parameter
- options
- OperationOptions
Die Optionen zum Erstellen einer neuen Registrierungs-ID.
Gibt zurück
Promise<string>
Die neu erstellte Registrierungs-ID.
deleteInstallation(string, OperationOptions)
Löscht eine Installation aus einem Benachrichtigungshub.
function deleteInstallation(installationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>Parameter
- installationId
-
string
Die Installations-ID der zu löschenden Installation.
- options
- OperationOptions
Konfigurationsoptionen für den Installationslöschvorgang.
Gibt zurück
Promise<NotificationHubsResponse>
Eine NotificationHubResponse mit der Nachverfolgungs-ID, der Korrelations-ID und dem Standort.
deleteRegistration(string, EntityOperationOptions)
Löscht eine Registrierung mit der angegebenen Registrierungs-ID.
function deleteRegistration(registrationId: string, options?: EntityOperationOptions): Promise<NotificationHubsResponse>Parameter
- registrationId
-
string
Die Registrierungs-ID der zu löschenden Registrierung.
- options
- EntityOperationOptions
Die Optionen für Löschvorgänge, einschließlich des ETags
Gibt zurück
Promise<NotificationHubsResponse>
Eine NotificationHubResponse mit der Nachverfolgungs-ID, der Korrelations-ID und dem Standort.
getFeedbackContainerUrl(OperationOptions)
Ruft eine Azure Storage-Container-URL ab. Der Container enthält Feedbackdaten für den Benachrichtigungshub. Der Aufrufer kann dann das Azure Storage Services SDK verwenden, um den Inhalt des Containers abzurufen.
function getFeedbackContainerUrl(options?: OperationOptions): Promise<string>Parameter
- options
- OperationOptions
Die Optionen zum Abrufen der Url des Feedbackcontainers für Pushbenachrichtigungen.
Gibt zurück
Promise<string>
Die URL des Azure Storage-Containers, der die Feedbackdaten enthält.
getInstallation(string, OperationOptions)
Ruft eine Azure Notification Hub-Installation durch die Installations-ID ab.
function getInstallation(installationId: string, options?: OperationOptions): Promise<Installation>Parameter
- installationId
-
string
Die ID der abzurufenden Installation.
- options
- OperationOptions
Konfigurationsoptionen für den Get-Installationsvorgang.
Gibt zurück
Promise<Installation>
Die Installation, die der Installations-ID entspricht.
getNotificationHubJob(string, OperationOptions)
Ruft einen Benachrichtigungshubauftrag anhand der ID ab.
function getNotificationHubJob(jobId: string, options?: OperationOptions): Promise<NotificationHubJob>Parameter
- jobId
-
string
Die Benachrichtigungshub-Auftrags-ID.
- options
- OperationOptions
Die Vorgangsoptionen.
Gibt zurück
Promise<NotificationHubJob>
Der Benachrichtigungshubauftrag mit der übereinstimmenden ID.
getNotificationOutcomeDetails(string, OperationOptions)
Ruft die Ergebnisse eines Sendevorgangs ab. Dadurch können Zwischenergebnisse abgerufen werden, wenn das Senden verarbeitet wird, oder endgültige Ergebnisse, wenn das Senden* abgeschlossen ist. Diese API kann nur für Standard-SKU und höher aufgerufen werden.
function getNotificationOutcomeDetails(notificationId: string, options?: OperationOptions): Promise<NotificationDetails>Parameter
- notificationId
-
string
Die vom Sendevorgang zurückgegebene Benachrichtigungs-ID.
- options
- OperationOptions
Die Vorgangsoptionen.
Gibt zurück
Promise<NotificationDetails>
Die Ergebnisse des Sendevorgangs.
getRegistration(string, OperationOptions)
Ruft eine Registrierung durch die angegebene Registrierungs-ID ab.
function getRegistration(registrationId: string, options?: OperationOptions): Promise<RegistrationDescription>Parameter
- registrationId
-
string
Die ID der Registrierung, die abgerufen werden soll.
- options
- OperationOptions
Die Optionen zum Abrufen einer Registrierung nach ID.
Gibt zurück
Promise<RegistrationDescription>
Eine RegistrationDescription mit der angegebenen Registrierungs-ID.
listNotificationHubJobs(OperationOptions)
Ruft alle Benachrichtigungshubaufträge für diesen Benachrichtigungshub ab.
function listNotificationHubJobs(options?: OperationOptions): Promise<NotificationHubJob[]>Parameter
- options
- OperationOptions
Die Vorgangsoptionen.
Gibt zurück
Promise<NotificationHubJob[]>
Ein Array aller Benachrichtigungshubaufträge für diesen Benachrichtigungshub.
listRegistrations(RegistrationQueryLimitOptions)
Ruft alle Registrierungen für den Benachrichtigungshub mit den angegebenen Abfrageoptionen ab.
function listRegistrations(options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Parameter
- options
- RegistrationQueryLimitOptions
Die Optionen zum Abfragen der Registrierungen wie $top.
Gibt zurück
Eine seitedseitige asynchrone Iterable mit allen Registrierungen für den Benachrichtigungshub.
listRegistrationsByChannel(RegistrationChannel, RegistrationQueryLimitOptions)
Ruft alle Registrierungen für den Benachrichtigungshub mit den angegebenen Geräteinformationen und Optionen ab.
function listRegistrationsByChannel(channel: RegistrationChannel, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Parameter
- channel
- RegistrationChannel
Die Registrierungskanalinformationen zum Abfragen pro PNS-Typ.
- options
- RegistrationQueryLimitOptions
Die Optionen zum Abfragen der Registrierungen wie $top.
Gibt zurück
Eine seitedseitige asynchrone Iterable mit allen Registrierungen für den Benachrichtigungshub.
listRegistrationsByTag(string, RegistrationQueryLimitOptions)
Listet alle Registrierungen mit dem entsprechenden Tag auf.
function listRegistrationsByTag(tag: string, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Parameter
- tag
-
string
Das Tag, das nach übereinstimmenden Registrierungen gesucht werden soll.
- options
- RegistrationQueryLimitOptions
Die Abfrageoptionen wie $top.
Gibt zurück
Eine seitedseitige asynchrone Iterable mit den übereinstimmenden Registrierungen für den Benachrichtigungshub.
scheduleBroadcastNotification(Date, Notification, OperationOptions)
Plant eine Pushbenachrichtigung an alle Geräte zum angegebenen Zeitpunkt. HINWEIS: Dies ist nur in den Azure-Benachrichtigungshubs der Standard-SKU verfügbar.
function scheduleBroadcastNotification(scheduledTime: Date, notification: Notification, options?: OperationOptions): Promise<NotificationHubsMessageResponse>Parameter
- scheduledTime
-
Date
Das Datum, an dem die Pushbenachrichtigung gesendet werden soll.
- notification
- Notification
Die Benachrichtigung, die an die übereinstimmenden Geräte gesendet werden soll.
- options
- OperationOptions
Die Vorgangsoptionen.
Gibt zurück
Promise<NotificationHubsMessageResponse>
Eine NotificationHubResponse mit der Nachverfolgungs-ID, der Korrelations-ID und dem Standort.
scheduleNotification(Date, Notification, ScheduleNotificationOptions)
Plant eine Pushbenachrichtigung auf Geräten, die den angegebenen Tags oder Tagausdrücken zum angegebenen Zeitpunkt entsprechen. HINWEIS: Dies ist nur in den Azure-Benachrichtigungshubs der Standard-SKU verfügbar.
function scheduleNotification(scheduledTime: Date, notification: Notification, options: ScheduleNotificationOptions): Promise<NotificationHubsMessageResponse>Parameter
- scheduledTime
-
Date
Das Datum, an dem die Pushbenachrichtigung gesendet werden soll.
- notification
- Notification
Die Benachrichtigung, die an die übereinstimmenden Geräte gesendet werden soll.
- options
- ScheduleNotificationOptions
Optionen, die Tags enthalten, die zum Ausrichten des Geräts für Pushbenachrichtigungen in einem Array- oder Tagausdruck verwendet werden.
Gibt zurück
Promise<NotificationHubsMessageResponse>
Eine NotificationHubResponse mit der Nachverfolgungs-ID, der Korrelations-ID und dem Standort.
sendBroadcastNotification(Notification, BroadcastSendNotificationOptions)
Sendet Pushbenachrichtigungen an Geräte aller Geräte.
function sendBroadcastNotification(notification: Notification, options?: BroadcastSendNotificationOptions): Promise<NotificationHubsMessageResponse>Parameter
- notification
- Notification
Die Benachrichtigung, die an alle Geräte gesendet werden soll.
- options
- BroadcastSendNotificationOptions
Optionen für die Benachrichtigung, einschließlich der Aktivierung der Testnachricht.
Gibt zurück
Promise<NotificationHubsMessageResponse>
Eine NotificationHubResponse mit der Nachverfolgungs-ID, der Korrelations-ID und dem Standort.
sendNotification(Notification, DirectSendNotificationOptions | SendNotificationOptions)
Sendet Pushbenachrichtigungen an Geräte, die den angegebenen Tags oder Tagausdrücken entsprechen.
function sendNotification(notification: Notification, options: DirectSendNotificationOptions | SendNotificationOptions): Promise<NotificationHubsMessageResponse>Parameter
- notification
- Notification
Die Benachrichtigung, die an die übereinstimmenden Geräte gesendet werden soll.
Optionen für die Benachrichtigung, einschließlich Tags, Gerätehandles und ob das Senden von Tests aktiviert werden soll.
Gibt zurück
Promise<NotificationHubsMessageResponse>
Eine NotificationHubResponse mit der Nachverfolgungs-ID, der Korrelations-ID und dem Standort.
submitNotificationHubJob(NotificationHubJob, OperationOptions)
Sendet einen Benachrichtigungshubauftrag. Beachten Sie, dass dies für den Standard-SKU-Namespace und höher verfügbar ist.
function submitNotificationHubJob(job: NotificationHubJob, options?: OperationOptions): Promise<NotificationHubJob>Parameter
Der zu sendende Benachrichtigungshubauftrag.
- options
- OperationOptions
Die Vorgangsoptionen.
Gibt zurück
Promise<NotificationHubJob>
Details des Benachrichtigungshubauftrags, einschließlich Auftrags-ID und Status.
updateInstallation(string, JsonPatch[], OperationOptions)
Aktualisiert eine Installation mithilfe des JSON-Patch Standards in RFC6902.
function updateInstallation(installationId: string, patches: JsonPatch[], options?: OperationOptions): Promise<NotificationHubsResponse>Parameter
- installationId
-
string
Die ID der zu aktualisierenden Installation.
- patches
Ein Array von Patches nach dem JSON-Patch Standard.
- options
- OperationOptions
Konfigurationsoptionen für den Patchinstallationsvorgang.
Gibt zurück
Promise<NotificationHubsResponse>
Eine NotificationHubResponse mit der Nachverfolgungs-ID, der Korrelations-ID und dem Standort.
updateRegistration(RegistrationDescription, OperationOptions)
Aktualisiert eine vorhandene Registrierung.
function updateRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Parameter
- registration
- RegistrationDescription
Die registrierung, die aktualisiert werden soll.
- options
- OperationOptions
Die Vorgangsoptionen.
Gibt zurück
Promise<RegistrationDescription>
Die aktualisierte Registrierungsbeschreibung.