NotificationHubsClient class
Představuje klienta pro Službu Azure Notification Hubs pro správu instalací a odesílání zpráv do zařízení.
Konstruktory
| Notification |
Vytvoří novou instanci NotificationClient s připojovacím řetězcem, názvem centra a možnostmi. |
Metody
| begin |
Odešle úlohu Centra oznámení a vytvoří poller k hlasování o výsledcích. |
| cancel |
Zruší naplánované oznámení s daným ID oznámení. |
| create |
Vytvoří nebo přepíše instalaci do centra oznámení. |
| create |
Vytvoří nebo aktualizuje registraci. |
| create |
Vytvoří novou registraci. Tato metoda vygeneruje ID registrace, které můžete následně použít k načtení, aktualizaci a odstranění této registrace. |
| create |
Vytvoří nové ID registrace. |
| delete |
Odstraní instalaci z centra oznámení. |
| delete |
Odstraní registraci s daným ID registrace. |
| get |
Načte adresu URL kontejneru Azure Storage. Kontejner má data zpětné vazby pro centrum oznámení. Volající pak může k načtení obsahu kontejneru použít sadu SDK služby Azure Storage Services. |
| get |
Získá instalaci centra oznámení Azure podle ID instalace. |
| get |
Získá úlohu centra oznámení podle ID. |
| get |
Načte výsledky operace odeslání. To může načíst přechodné výsledky, pokud se odeslání zpracovává nebo konečné výsledky, pokud se dokončilo odeslání*. Toto rozhraní API lze volat pouze pro skladovou položku Standard a vyšší. |
| get |
Získá registraci podle daného ID registrace. |
| list |
Získá všechny úlohy centra oznámení pro toto centrum oznámení. |
| list |
Získá všechny registrace pro centrum oznámení s danými možnostmi dotazu. |
| list |
Získá všechny registrace pro centrum oznámení s danými informacemi a možnostmi zařízení. |
| list |
Zobrazí seznam všech registrací s odpovídající značkou. |
| schedule |
Naplánuje nabízené oznámení pro všechna zařízení v určený čas. POZNÁMKA: Tato možnost je dostupná pouze ve službě Azure Notification Hubs úrovně Standard. |
| schedule |
Naplánuje nabízené oznámení zařízením, která odpovídají zadaným značkám nebo výrazům značek. POZNÁMKA: Tato možnost je dostupná pouze ve službě Azure Notification Hubs úrovně Standard. |
| send |
Odesílá nabízená oznámení na zařízení všechna zařízení. |
| send |
Odesílá nabízená oznámení zařízením, která odpovídají zadaným značkám nebo výrazu značky. |
| submit |
Odešle úlohu centra oznámení. Všimněte si, že je k dispozici pro obor názvů skladové položky Standard a vyšší. |
| update |
Aktualizuje instalaci pomocí standardu JSON-Patch RFC6902 RFC6902. |
| update |
Aktualizuje existující registraci. |
Podrobnosti konstruktoru
NotificationHubsClient(string, string, NotificationHubsClientOptions)
Vytvoří novou instanci NotificationClient s připojovacím řetězcem, názvem centra a možnostmi.
new NotificationHubsClient(connectionString: string, hubName: string, options?: NotificationHubsClientOptions)Parametry
- connectionString
-
string
Připojovací řetězec zásad přístupu centra oznámení.
- hubName
-
string
Název centra oznámení Azure.
- options
- NotificationHubsClientOptions
Možnosti konfigurace klienta služby Azure Notification Hubs
Podrobnosti metody
beginSubmitNotificationHubJob(NotificationHubJob, PolledOperationOptions)
Odešle úlohu Centra oznámení a vytvoří poller k hlasování o výsledcích.
function beginSubmitNotificationHubJob(notificationHubJob: NotificationHubJob, options?: PolledOperationOptions): Promise<NotificationHubJobPoller>Parametry
- notificationHubJob
- NotificationHubJob
Spustí se úloha importu nebo exportu centra oznámení.
- options
- PolledOperationOptions
Možnosti operace.
Návraty
Promise<NotificationHubJobPoller>
Do dokončení úlohy je možné volat poller, který lze volat k dotazování.
cancelScheduledNotification(string, OperationOptions)
Zruší naplánované oznámení s daným ID oznámení.
function cancelScheduledNotification(notificationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>Parametry
- notificationId
-
string
ID oznámení z naplánovaného oznámení.
- options
- OperationOptions
Možnosti operace.
Návraty
Promise<NotificationHubsResponse>
Odpověď centra oznámení s ID korelace a ID sledování
createOrUpdateInstallation(Installation, OperationOptions)
Vytvoří nebo přepíše instalaci do centra oznámení.
function createOrUpdateInstallation(installation: Installation, options?: OperationOptions): Promise<NotificationHubsResponse>Parametry
- installation
- Installation
Instalace, která se má vytvořit nebo přepsat.
- options
- OperationOptions
Možnosti konfigurace pro operaci vytvoření nebo aktualizace instalace
Návraty
Promise<NotificationHubsResponse>
NotificationHubResponse s ID sledování, ID korelace a umístěním.
createOrUpdateRegistration(RegistrationDescription, OperationOptions)
Vytvoří nebo aktualizuje registraci.
function createOrUpdateRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Parametry
- registration
- RegistrationDescription
Registrace k vytvoření nebo aktualizaci.
- options
- OperationOptions
Možnosti operace.
Návraty
Promise<RegistrationDescription>
Vytvořený nebo aktualizovaný popis registrace.
createRegistration(RegistrationDescription, OperationOptions)
Vytvoří novou registraci. Tato metoda vygeneruje ID registrace, které můžete následně použít k načtení, aktualizaci a odstranění této registrace.
function createRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Parametry
- registration
- RegistrationDescription
Registrace, která se má vytvořit.
- options
- OperationOptions
Možnosti pro vytvoření nové registrace
Návraty
Promise<RegistrationDescription>
Popis nově vytvořené registrace.
createRegistrationId(OperationOptions)
Vytvoří nové ID registrace.
function createRegistrationId(options?: OperationOptions): Promise<string>Parametry
- options
- OperationOptions
Možnosti pro vytvoření nového ID registrace
Návraty
Promise<string>
Nově vytvořené ID registrace.
deleteInstallation(string, OperationOptions)
Odstraní instalaci z centra oznámení.
function deleteInstallation(installationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>Parametry
- installationId
-
string
ID instalace instalace, která se má odstranit.
- options
- OperationOptions
Možnosti konfigurace operace odstranění instalace
Návraty
Promise<NotificationHubsResponse>
NotificationHubResponse s ID sledování, ID korelace a umístěním.
deleteRegistration(string, EntityOperationOptions)
Odstraní registraci s daným ID registrace.
function deleteRegistration(registrationId: string, options?: EntityOperationOptions): Promise<NotificationHubsResponse>Parametry
- registrationId
-
string
ID registrace registrace, která se má odstranit.
- options
- EntityOperationOptions
Možnosti operací odstranění včetně značky ETag
Návraty
Promise<NotificationHubsResponse>
NotificationHubResponse s ID sledování, ID korelace a umístěním.
getFeedbackContainerUrl(OperationOptions)
Načte adresu URL kontejneru Azure Storage. Kontejner má data zpětné vazby pro centrum oznámení. Volající pak může k načtení obsahu kontejneru použít sadu SDK služby Azure Storage Services.
function getFeedbackContainerUrl(options?: OperationOptions): Promise<string>Parametry
- options
- OperationOptions
Možnosti získání adresy URL kontejneru zpětné vazby nabízených oznámení
Návraty
Promise<string>
Adresa URL kontejneru azure Storage obsahujícího data zpětné vazby.
getInstallation(string, OperationOptions)
Získá instalaci centra oznámení Azure podle ID instalace.
function getInstallation(installationId: string, options?: OperationOptions): Promise<Installation>Parametry
- installationId
-
string
ID instalace, které chcete získat.
- options
- OperationOptions
Možnosti konfigurace pro operaci získání instalace
Návraty
Promise<Installation>
Instalace, která odpovídá ID instalace.
getNotificationHubJob(string, OperationOptions)
Získá úlohu centra oznámení podle ID.
function getNotificationHubJob(jobId: string, options?: OperationOptions): Promise<NotificationHubJob>Parametry
- jobId
-
string
ID úlohy centra oznámení.
- options
- OperationOptions
Možnosti operace.
Návraty
Promise<NotificationHubJob>
Úloha centra oznámení s odpovídajícím ID.
getNotificationOutcomeDetails(string, OperationOptions)
Načte výsledky operace odeslání. To může načíst přechodné výsledky, pokud se odeslání zpracovává nebo konečné výsledky, pokud se dokončilo odeslání*. Toto rozhraní API lze volat pouze pro skladovou položku Standard a vyšší.
function getNotificationOutcomeDetails(notificationId: string, options?: OperationOptions): Promise<NotificationDetails>Parametry
- notificationId
-
string
ID oznámení vrácené z operace odeslání.
- options
- OperationOptions
Možnosti operace.
Návraty
Promise<NotificationDetails>
Výsledky operace odeslání.
getRegistration(string, OperationOptions)
Získá registraci podle daného ID registrace.
function getRegistration(registrationId: string, options?: OperationOptions): Promise<RegistrationDescription>Parametry
- registrationId
-
string
ID registrace, které chcete získat.
- options
- OperationOptions
Možnosti získání registrace podle ID
Návraty
Promise<RegistrationDescription>
A RegistrationDescription, který má dané ID registrace.
listNotificationHubJobs(OperationOptions)
Získá všechny úlohy centra oznámení pro toto centrum oznámení.
function listNotificationHubJobs(options?: OperationOptions): Promise<NotificationHubJob[]>Parametry
- options
- OperationOptions
Možnosti operace.
Návraty
Promise<NotificationHubJob[]>
Pole všech úloh centra oznámení pro toto centrum oznámení.
listRegistrations(RegistrationQueryLimitOptions)
Získá všechny registrace pro centrum oznámení s danými možnostmi dotazu.
function listRegistrations(options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Parametry
- options
- RegistrationQueryLimitOptions
Možnosti dotazování registrací, jako jsou $top.
Návraty
Stránkovaná asynchronní iterace obsahující všechny registrace centra oznámení.
listRegistrationsByChannel(RegistrationChannel, RegistrationQueryLimitOptions)
Získá všechny registrace pro centrum oznámení s danými informacemi a možnostmi zařízení.
function listRegistrationsByChannel(channel: RegistrationChannel, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Parametry
- channel
- RegistrationChannel
Informace o registračním kanálu pro dotazování na typ PNS.
- options
- RegistrationQueryLimitOptions
Možnosti dotazování registrací, jako jsou $top.
Návraty
Stránkovaná asynchronní iterace obsahující všechny registrace centra oznámení.
listRegistrationsByTag(string, RegistrationQueryLimitOptions)
Zobrazí seznam všech registrací s odpovídající značkou.
function listRegistrationsByTag(tag: string, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Parametry
- tag
-
string
Značka, která se má dotazovat na odpovídající registrace.
- options
- RegistrationQueryLimitOptions
Možnosti dotazu, například $top.
Návraty
Stránka s asynchronní iterací obsahující odpovídající registrace centra oznámení.
scheduleBroadcastNotification(Date, Notification, OperationOptions)
Naplánuje nabízené oznámení pro všechna zařízení v určený čas. POZNÁMKA: Tato možnost je dostupná pouze ve službě Azure Notification Hubs úrovně Standard.
function scheduleBroadcastNotification(scheduledTime: Date, notification: Notification, options?: OperationOptions): Promise<NotificationHubsMessageResponse>Parametry
- scheduledTime
-
Date
Datum odeslání nabízeného oznámení.
- notification
- Notification
Oznámení, které se má odeslat na odpovídající zařízení.
- options
- OperationOptions
Možnosti operace.
Návraty
Promise<NotificationHubsMessageResponse>
NotificationHubResponse s ID sledování, ID korelace a umístěním.
scheduleNotification(Date, Notification, ScheduleNotificationOptions)
Naplánuje nabízené oznámení zařízením, která odpovídají zadaným značkám nebo výrazům značek. POZNÁMKA: Tato možnost je dostupná pouze ve službě Azure Notification Hubs úrovně Standard.
function scheduleNotification(scheduledTime: Date, notification: Notification, options: ScheduleNotificationOptions): Promise<NotificationHubsMessageResponse>Parametry
- scheduledTime
-
Date
Datum odeslání nabízeného oznámení.
- notification
- Notification
Oznámení, které se má odeslat na odpovídající zařízení.
- options
- ScheduleNotificationOptions
Možnosti, které zahrnují značky používané k cílení na zařízení pro nabízená oznámení ve výrazu pole nebo značky.
Návraty
Promise<NotificationHubsMessageResponse>
NotificationHubResponse s ID sledování, ID korelace a umístěním.
sendBroadcastNotification(Notification, BroadcastSendNotificationOptions)
Odesílá nabízená oznámení na zařízení všechna zařízení.
function sendBroadcastNotification(notification: Notification, options?: BroadcastSendNotificationOptions): Promise<NotificationHubsMessageResponse>Parametry
- notification
- Notification
Oznámení, které se má odeslat na všechna zařízení.
- options
- BroadcastSendNotificationOptions
Možnosti oznámení, včetně toho, jestli se má povolit testovací odeslání
Návraty
Promise<NotificationHubsMessageResponse>
NotificationHubResponse s ID sledování, ID korelace a umístěním.
sendNotification(Notification, DirectSendNotificationOptions | SendNotificationOptions)
Odesílá nabízená oznámení zařízením, která odpovídají zadaným značkám nebo výrazu značky.
function sendNotification(notification: Notification, options: DirectSendNotificationOptions | SendNotificationOptions): Promise<NotificationHubsMessageResponse>Parametry
- notification
- Notification
Oznámení, které se má odeslat na odpovídající zařízení.
Možnosti oznámení, včetně značek, popisovačů zařízení a toho, jestli se má povolit testovací odeslání
Návraty
Promise<NotificationHubsMessageResponse>
NotificationHubResponse s ID sledování, ID korelace a umístěním.
submitNotificationHubJob(NotificationHubJob, OperationOptions)
Odešle úlohu centra oznámení. Všimněte si, že je k dispozici pro obor názvů skladové položky Standard a vyšší.
function submitNotificationHubJob(job: NotificationHubJob, options?: OperationOptions): Promise<NotificationHubJob>Parametry
Úloha centra oznámení, která se má odeslat.
- options
- OperationOptions
Možnosti operace.
Návraty
Promise<NotificationHubJob>
Podrobnosti o úloze centra oznámení, včetně ID úlohy a stavu.
updateInstallation(string, JsonPatch[], OperationOptions)
Aktualizuje instalaci pomocí standardu JSON-Patch RFC6902 RFC6902.
function updateInstallation(installationId: string, patches: JsonPatch[], options?: OperationOptions): Promise<NotificationHubsResponse>Parametry
- installationId
-
string
ID instalace, která se má aktualizovat.
- patches
Pole oprav, které následují za standardem JSON-Patch.
- options
- OperationOptions
Možnosti konfigurace pro operaci instalace oprav
Návraty
Promise<NotificationHubsResponse>
NotificationHubResponse s ID sledování, ID korelace a umístěním.
updateRegistration(RegistrationDescription, OperationOptions)
Aktualizuje existující registraci.
function updateRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Parametry
- registration
- RegistrationDescription
Registrace, která se má aktualizovat.
- options
- OperationOptions
Možnosti operace.
Návraty
Promise<RegistrationDescription>
Aktualizovaný popis registrace.