NotificationHubsClient class
Reprezentuje to klienta usługi Azure Notification Hubs do zarządzania instalacjami i wysyłania komunikatów do urządzeń.
Konstruktory
| Notification |
Tworzy nowe wystąpienie elementu NotificationClient z parametrami połączenia, nazwą centrum i opcjami. |
Metody
| begin |
Przesyła zadanie usługi Notification Hub i tworzy narzędzie poller w celu sondowania wyników. |
| cancel |
Anuluje zaplanowane powiadomienie przy użyciu podanego identyfikatora powiadomienia. |
| create |
Tworzy lub zastępuje instalację w centrum powiadomień. |
| create |
Tworzy lub aktualizuje rejestrację. |
| create |
Tworzy nową rejestrację. Ta metoda generuje identyfikator rejestracji, którego następnie można użyć do pobrania, zaktualizowania i usunięcia tej rejestracji. |
| create |
Tworzy nowy identyfikator rejestracji. |
| delete |
Usuwa instalację z centrum powiadomień. |
| delete |
Usuwa rejestrację z danym identyfikatorem rejestracji. |
| get |
Pobiera adres URL kontenera usługi Azure Storage. Kontener zawiera dane opinii dotyczące centrum powiadomień. Obiekt wywołujący może następnie pobrać zawartość kontenera przy użyciu zestawu SDK usług Azure Storage. |
| get |
Pobiera instalację usługi Azure Notification Hub według identyfikatora instalacji. |
| get |
Pobiera zadanie centrum powiadomień według identyfikatora. |
| get |
Pobiera wyniki operacji wysyłania. Może to pobierać wyniki pośrednie, jeśli wysyłanie jest przetwarzane lub końcowe wyniki, jeśli wysyłanie* zostało ukończone. Ten interfejs API może być wywoływany tylko dla jednostki SKU w warstwie Standardowa i nowszych. |
| get |
Pobiera rejestrację według podanego identyfikatora rejestracji. |
| list |
Pobiera wszystkie zadania centrum powiadomień dla tego centrum powiadomień. |
| list |
Pobiera wszystkie rejestracje centrum powiadomień z podanymi opcjami zapytania. |
| list |
Pobiera wszystkie rejestracje centrum powiadomień z podanymi informacjami i opcjami urządzenia. |
| list |
Wyświetla listę wszystkich rejestracji z pasującym tagiem. |
| schedule |
Planuje powiadomienie wypychane do wszystkich urządzeń w określonym czasie. UWAGA: Jest to dostępne tylko w usłudze Azure Notification Hubs w warstwie Standardowa. |
| schedule |
Planuje wysyłanie powiadomień wypychanych do urządzeń, które są zgodne z danym tagiem lub wyrażeniem tagu w określonym czasie. UWAGA: Jest to dostępne tylko w usłudze Azure Notification Hubs w warstwie Standardowa. |
| send |
Wysyła powiadomienia wypychane do wszystkich urządzeń. |
| send |
Wysyła powiadomienia wypychane do urządzeń, które pasują do danego tagu lub wyrażenia tagu. |
| submit |
Przesyła zadanie centrum powiadomień. Należy pamiętać, że jest to dostępne dla przestrzeni nazw jednostki SKU w warstwie Standardowa i nowszych. |
| update |
Aktualizuje instalację przy użyciu standardu JSON-Patch w RFC6902. |
| update |
Aktualizuje istniejącą rejestrację. |
Szczegóły konstruktora
NotificationHubsClient(string, string, NotificationHubsClientOptions)
Tworzy nowe wystąpienie elementu NotificationClient z parametrami połączenia, nazwą centrum i opcjami.
new NotificationHubsClient(connectionString: string, hubName: string, options?: NotificationHubsClientOptions)Parametry
- connectionString
-
string
Parametry połączenia zasad dostępu centrum powiadomień.
- hubName
-
string
Nazwa usługi Azure Notification Hub.
- options
- NotificationHubsClientOptions
Opcje konfigurowania klienta usługi Azure Notification Hubs.
Szczegóły metody
beginSubmitNotificationHubJob(NotificationHubJob, PolledOperationOptions)
Przesyła zadanie usługi Notification Hub i tworzy narzędzie poller w celu sondowania wyników.
function beginSubmitNotificationHubJob(notificationHubJob: NotificationHubJob, options?: PolledOperationOptions): Promise<NotificationHubJobPoller>Parametry
- notificationHubJob
- NotificationHubJob
Zadanie importowania/eksportowania centrum powiadomień do uruchomienia.
- options
- PolledOperationOptions
Opcje operacji.
Zwraca
Promise<NotificationHubJobPoller>
Poller, który można wywołać w celu sondowania do momentu zakończenia zadania.
cancelScheduledNotification(string, OperationOptions)
Anuluje zaplanowane powiadomienie przy użyciu podanego identyfikatora powiadomienia.
function cancelScheduledNotification(notificationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>Parametry
- notificationId
-
string
Identyfikator powiadomienia z zaplanowanego powiadomienia.
- options
- OperationOptions
Opcje operacji.
Zwraca
Promise<NotificationHubsResponse>
Odpowiedź centrum powiadomień z identyfikatorem korelacji i identyfikatorem śledzenia.
createOrUpdateInstallation(Installation, OperationOptions)
Tworzy lub zastępuje instalację w centrum powiadomień.
function createOrUpdateInstallation(installation: Installation, options?: OperationOptions): Promise<NotificationHubsResponse>Parametry
- installation
- Installation
Instalacja do utworzenia lub zastąpienia.
- options
- OperationOptions
Opcje konfiguracji dla operacji tworzenia lub aktualizowania instalacji.
Zwraca
Promise<NotificationHubsResponse>
PowiadomienieHubResponse z identyfikatorem śledzenia, identyfikatorem korelacji i lokalizacją.
createOrUpdateRegistration(RegistrationDescription, OperationOptions)
Tworzy lub aktualizuje rejestrację.
function createOrUpdateRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Parametry
- registration
- RegistrationDescription
Rejestracja w celu utworzenia lub zaktualizowania.
- options
- OperationOptions
Opcje operacji.
Zwraca
Promise<RegistrationDescription>
Utworzony lub zaktualizowany opis rejestracji.
createRegistration(RegistrationDescription, OperationOptions)
Tworzy nową rejestrację. Ta metoda generuje identyfikator rejestracji, którego następnie można użyć do pobrania, zaktualizowania i usunięcia tej rejestracji.
function createRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Parametry
- registration
- RegistrationDescription
Rejestracja do utworzenia.
- options
- OperationOptions
Opcje tworzenia nowej rejestracji.
Zwraca
Promise<RegistrationDescription>
Nowo utworzony opis rejestracji.
createRegistrationId(OperationOptions)
Tworzy nowy identyfikator rejestracji.
function createRegistrationId(options?: OperationOptions): Promise<string>Parametry
- options
- OperationOptions
Opcje tworzenia nowego identyfikatora rejestracji.
Zwraca
Promise<string>
Nowo utworzony identyfikator rejestracji.
deleteInstallation(string, OperationOptions)
Usuwa instalację z centrum powiadomień.
function deleteInstallation(installationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>Parametry
- installationId
-
string
Identyfikator instalacji do usunięcia.
- options
- OperationOptions
Opcje konfiguracji operacji usuwania instalacji.
Zwraca
Promise<NotificationHubsResponse>
PowiadomienieHubResponse z identyfikatorem śledzenia, identyfikatorem korelacji i lokalizacją.
deleteRegistration(string, EntityOperationOptions)
Usuwa rejestrację z danym identyfikatorem rejestracji.
function deleteRegistration(registrationId: string, options?: EntityOperationOptions): Promise<NotificationHubsResponse>Parametry
- registrationId
-
string
Identyfikator rejestracji do usunięcia.
- options
- EntityOperationOptions
Opcje operacji usuwania, w tym elementu ETag
Zwraca
Promise<NotificationHubsResponse>
PowiadomienieHubResponse z identyfikatorem śledzenia, identyfikatorem korelacji i lokalizacją.
getFeedbackContainerUrl(OperationOptions)
Pobiera adres URL kontenera usługi Azure Storage. Kontener zawiera dane opinii dotyczące centrum powiadomień. Obiekt wywołujący może następnie pobrać zawartość kontenera przy użyciu zestawu SDK usług Azure Storage.
function getFeedbackContainerUrl(options?: OperationOptions): Promise<string>Parametry
- options
- OperationOptions
Opcje uzyskiwania adresu URL kontenera opinii o powiadomieniach wypychanych.
Zwraca
Promise<string>
Adres URL kontenera usługi Azure Storage zawierający dane opinii.
getInstallation(string, OperationOptions)
Pobiera instalację usługi Azure Notification Hub według identyfikatora instalacji.
function getInstallation(installationId: string, options?: OperationOptions): Promise<Installation>Parametry
- installationId
-
string
Identyfikator instalacji do pobrania.
- options
- OperationOptions
Opcje konfiguracji dla operacji pobierania instalacji.
Zwraca
Promise<Installation>
Instalacja zgodna z identyfikatorem instalacji.
getNotificationHubJob(string, OperationOptions)
Pobiera zadanie centrum powiadomień według identyfikatora.
function getNotificationHubJob(jobId: string, options?: OperationOptions): Promise<NotificationHubJob>Parametry
- jobId
-
string
Identyfikator zadania centrum powiadomień.
- options
- OperationOptions
Opcje operacji.
Zwraca
Promise<NotificationHubJob>
Zadanie centrum powiadomień z pasującym identyfikatorem.
getNotificationOutcomeDetails(string, OperationOptions)
Pobiera wyniki operacji wysyłania. Może to pobierać wyniki pośrednie, jeśli wysyłanie jest przetwarzane lub końcowe wyniki, jeśli wysyłanie* zostało ukończone. Ten interfejs API może być wywoływany tylko dla jednostki SKU w warstwie Standardowa i nowszych.
function getNotificationOutcomeDetails(notificationId: string, options?: OperationOptions): Promise<NotificationDetails>Parametry
- notificationId
-
string
Identyfikator powiadomienia zwrócony z operacji wysyłania.
- options
- OperationOptions
Opcje operacji.
Zwraca
Promise<NotificationDetails>
Wyniki operacji wysyłania.
getRegistration(string, OperationOptions)
Pobiera rejestrację według podanego identyfikatora rejestracji.
function getRegistration(registrationId: string, options?: OperationOptions): Promise<RegistrationDescription>Parametry
- registrationId
-
string
Identyfikator rejestracji do pobrania.
- options
- OperationOptions
Opcje pobierania rejestracji według identyfikatora.
Zwraca
Promise<RegistrationDescription>
Opis rejestracji, który ma podany identyfikator rejestracji.
listNotificationHubJobs(OperationOptions)
Pobiera wszystkie zadania centrum powiadomień dla tego centrum powiadomień.
function listNotificationHubJobs(options?: OperationOptions): Promise<NotificationHubJob[]>Parametry
- options
- OperationOptions
Opcje operacji.
Zwraca
Promise<NotificationHubJob[]>
Tablica wszystkich zadań centrum powiadomień dla tego centrum powiadomień.
listRegistrations(RegistrationQueryLimitOptions)
Pobiera wszystkie rejestracje centrum powiadomień z podanymi opcjami zapytania.
function listRegistrations(options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Parametry
- options
- RegistrationQueryLimitOptions
Opcje wykonywania zapytań dotyczących rejestracji, takich jak $top.
Zwraca
Stronicowana iterowana iterowana zawierająca wszystkie rejestracje centrum powiadomień.
listRegistrationsByChannel(RegistrationChannel, RegistrationQueryLimitOptions)
Pobiera wszystkie rejestracje centrum powiadomień z podanymi informacjami i opcjami urządzenia.
function listRegistrationsByChannel(channel: RegistrationChannel, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Parametry
- channel
- RegistrationChannel
Informacje o kanale rejestracji do wykonywania zapytań na typ pnS.
- options
- RegistrationQueryLimitOptions
Opcje wykonywania zapytań dotyczących rejestracji, takich jak $top.
Zwraca
Stronicowana iterowana iterowana zawierająca wszystkie rejestracje centrum powiadomień.
listRegistrationsByTag(string, RegistrationQueryLimitOptions)
Wyświetla listę wszystkich rejestracji z pasującym tagiem.
function listRegistrationsByTag(tag: string, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Parametry
- tag
-
string
Tag do wykonywania zapytań dotyczących pasujących rejestracji.
- options
- RegistrationQueryLimitOptions
Opcje zapytania, takie jak $top.
Zwraca
Stronicowana iterowana iterowana zawierająca pasujące rejestracje dla centrum powiadomień.
scheduleBroadcastNotification(Date, Notification, OperationOptions)
Planuje powiadomienie wypychane do wszystkich urządzeń w określonym czasie. UWAGA: Jest to dostępne tylko w usłudze Azure Notification Hubs w warstwie Standardowa.
function scheduleBroadcastNotification(scheduledTime: Date, notification: Notification, options?: OperationOptions): Promise<NotificationHubsMessageResponse>Parametry
- scheduledTime
-
Date
Data wysłania powiadomienia push.
- notification
- Notification
Powiadomienie wysyłane do pasujących urządzeń.
- options
- OperationOptions
Opcje operacji.
Zwraca
Promise<NotificationHubsMessageResponse>
PowiadomienieHubResponse z identyfikatorem śledzenia, identyfikatorem korelacji i lokalizacją.
scheduleNotification(Date, Notification, ScheduleNotificationOptions)
Planuje wysyłanie powiadomień wypychanych do urządzeń, które są zgodne z danym tagiem lub wyrażeniem tagu w określonym czasie. UWAGA: Jest to dostępne tylko w usłudze Azure Notification Hubs w warstwie Standardowa.
function scheduleNotification(scheduledTime: Date, notification: Notification, options: ScheduleNotificationOptions): Promise<NotificationHubsMessageResponse>Parametry
- scheduledTime
-
Date
Data wysłania powiadomienia push.
- notification
- Notification
Powiadomienie wysyłane do pasujących urządzeń.
- options
- ScheduleNotificationOptions
Opcje, które obejmują tagi używane do określania celu urządzenia na potrzeby powiadomień wypychanych w wyrażeniu tablicy lub tagu.
Zwraca
Promise<NotificationHubsMessageResponse>
PowiadomienieHubResponse z identyfikatorem śledzenia, identyfikatorem korelacji i lokalizacją.
sendBroadcastNotification(Notification, BroadcastSendNotificationOptions)
Wysyła powiadomienia wypychane do wszystkich urządzeń.
function sendBroadcastNotification(notification: Notification, options?: BroadcastSendNotificationOptions): Promise<NotificationHubsMessageResponse>Parametry
- notification
- Notification
Powiadomienie wysyłane do wszystkich urządzeń.
- options
- BroadcastSendNotificationOptions
Opcje powiadomienia, w tym informacje o tym, czy włączyć wysyłanie testowe.
Zwraca
Promise<NotificationHubsMessageResponse>
PowiadomienieHubResponse z identyfikatorem śledzenia, identyfikatorem korelacji i lokalizacją.
sendNotification(Notification, DirectSendNotificationOptions | SendNotificationOptions)
Wysyła powiadomienia wypychane do urządzeń, które pasują do danego tagu lub wyrażenia tagu.
function sendNotification(notification: Notification, options: DirectSendNotificationOptions | SendNotificationOptions): Promise<NotificationHubsMessageResponse>Parametry
- notification
- Notification
Powiadomienie wysyłane do pasujących urządzeń.
Opcje powiadomienia, w tym tagi, dojścia urządzenia i czy włączyć wysyłanie testowe.
Zwraca
Promise<NotificationHubsMessageResponse>
PowiadomienieHubResponse z identyfikatorem śledzenia, identyfikatorem korelacji i lokalizacją.
submitNotificationHubJob(NotificationHubJob, OperationOptions)
Przesyła zadanie centrum powiadomień. Należy pamiętać, że jest to dostępne dla przestrzeni nazw jednostki SKU w warstwie Standardowa i nowszych.
function submitNotificationHubJob(job: NotificationHubJob, options?: OperationOptions): Promise<NotificationHubJob>Parametry
Zadanie centrum powiadomień do przesłania.
- options
- OperationOptions
Opcje operacji.
Zwraca
Promise<NotificationHubJob>
Szczegóły zadania centrum powiadomień, w tym identyfikator zadania i stan.
updateInstallation(string, JsonPatch[], OperationOptions)
Aktualizuje instalację przy użyciu standardu JSON-Patch w RFC6902.
function updateInstallation(installationId: string, patches: JsonPatch[], options?: OperationOptions): Promise<NotificationHubsResponse>Parametry
- installationId
-
string
Identyfikator instalacji do zaktualizowania.
- patches
Tablica poprawek zgodnie z JSON-Patch standardem.
- options
- OperationOptions
Opcje konfiguracji operacji instalacji poprawek.
Zwraca
Promise<NotificationHubsResponse>
PowiadomienieHubResponse z identyfikatorem śledzenia, identyfikatorem korelacji i lokalizacją.
updateRegistration(RegistrationDescription, OperationOptions)
Aktualizuje istniejącą rejestrację.
function updateRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Parametry
- registration
- RegistrationDescription
Rejestracja do zaktualizowania.
- options
- OperationOptions
Opcje operacji.
Zwraca
Promise<RegistrationDescription>
Zaktualizowany opis rejestracji.