NotificationHubsClient class
Rappresenta un client per Hub di notifica di Azure per gestire le installazioni e inviare messaggi ai dispositivi.
Costruttori
| Notification |
Crea una nuova istanza di NotificationClient con una stringa di connessione, il nome e le opzioni dell'hub. |
Metodi
| begin |
Invia un processo di Hub di notifica e crea un poller per eseguire il polling dei risultati. |
| cancel |
Annulla la notifica pianificata con l'ID di notifica specificato. |
| create |
Crea o sovrascrive un'installazione in un hub di notifica. |
| create |
Crea o aggiorna una registrazione. |
| create |
Crea una nuova registrazione. Questo metodo genera un ID di registrazione, che è possibile usare successivamente per recuperare, aggiornare ed eliminare questa registrazione. |
| create |
Crea un nuovo ID registrazione. |
| delete |
Elimina un'installazione da un hub di notifica. |
| delete |
Elimina una registrazione con l'ID di registrazione specificato. |
| get |
Recupera un URL del contenitore di Archiviazione di Azure. Il contenitore contiene dati di feedback per l'hub di notifica. Il chiamante può quindi usare Azure Storage Services SDK per recuperare il contenuto del contenitore. |
| get |
Ottiene un'installazione dell'hub di notifica di Azure in base all'ID di installazione. |
| get |
Ottiene un processo dell'hub di notifica in base all'ID. |
| get |
Recupera i risultati di un'operazione di invio. In questo modo è possibile recuperare i risultati intermedi se l'invio viene elaborato o i risultati finali se l'oggetto Send* è stato completato. Questa API può essere chiamata solo per SKU Standard e versioni successive. |
| get |
Ottiene una registrazione in base all'ID di registrazione specificato. |
| list |
Ottiene tutti i processi dell'hub di notifica per l'hub di notifica. |
| list |
Ottiene tutte le registrazioni per l'hub di notifica con le opzioni di query specificate. |
| list |
Ottiene tutte le registrazioni per l'hub di notifica con le informazioni e le opzioni del dispositivo specificate. |
| list |
Elenca tutte le registrazioni con il tag corrispondente. |
| schedule |
Pianifica una notifica push a tutti i dispositivi all'ora specificata. NOTA: questa opzione è disponibile solo in Hub di notifica di Azure CON SKU Standard. |
| schedule |
Pianifica una notifica push ai dispositivi che corrispondono ai tag o all'espressione di tag specificati all'ora specificata. NOTA: questa opzione è disponibile solo in Hub di notifica di Azure CON SKU Standard. |
| send |
Invia notifiche push a tutti i dispositivi. |
| send |
Invia notifiche push ai dispositivi che corrispondono ai tag o all'espressione di tag specificati. |
| submit |
Invia un processo dell'hub di notifica. Si noti che è disponibile per lo spazio dei nomi SKU Standard e versioni successive. |
| update |
Aggiorna un'installazione usando lo standard JSON-Patch in RFC6902. |
| update |
Aggiorna una registrazione esistente. |
Dettagli costruttore
NotificationHubsClient(string, string, NotificationHubsClientOptions)
Crea una nuova istanza di NotificationClient con una stringa di connessione, il nome e le opzioni dell'hub.
new NotificationHubsClient(connectionString: string, hubName: string, options?: NotificationHubsClientOptions)Parametri
- connectionString
-
string
Stringa di connessione dei criteri di accesso dell'hub di notifica.
- hubName
-
string
Nome dell'hub di notifica di Azure.
- options
- NotificationHubsClientOptions
Opzioni per la configurazione del client di Hub di notifica di Azure.
Dettagli metodo
beginSubmitNotificationHubJob(NotificationHubJob, PolledOperationOptions)
Invia un processo di Hub di notifica e crea un poller per eseguire il polling dei risultati.
function beginSubmitNotificationHubJob(notificationHubJob: NotificationHubJob, options?: PolledOperationOptions): Promise<NotificationHubJobPoller>Parametri
- notificationHubJob
- NotificationHubJob
Processo di importazione/esportazione dell'hub di notifica da avviare.
- options
- PolledOperationOptions
Opzioni dell'operazione.
Restituisce
Promise<NotificationHubJobPoller>
Un poller che può essere chiamato per eseguire il polling fino al completamento del processo.
cancelScheduledNotification(string, OperationOptions)
Annulla la notifica pianificata con l'ID di notifica specificato.
function cancelScheduledNotification(notificationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>Parametri
- notificationId
-
string
ID notifica della notifica pianificata.
- options
- OperationOptions
Opzioni dell'operazione.
Restituisce
Promise<NotificationHubsResponse>
Risposta dell'hub di notifica con ID di correlazione e ID di rilevamento.
createOrUpdateInstallation(Installation, OperationOptions)
Crea o sovrascrive un'installazione in un hub di notifica.
function createOrUpdateInstallation(installation: Installation, options?: OperationOptions): Promise<NotificationHubsResponse>Parametri
- installation
- Installation
Installazione da creare o sovrascrivere.
- options
- OperationOptions
Opzioni di configurazione per l'operazione di creazione o aggiornamento dell'installazione.
Restituisce
Promise<NotificationHubsResponse>
NotificationHubResponse con l'ID di rilevamento, l'ID di correlazione e la posizione.
createOrUpdateRegistration(RegistrationDescription, OperationOptions)
Crea o aggiorna una registrazione.
function createOrUpdateRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Parametri
- registration
- RegistrationDescription
Registrazione da creare o aggiornare.
- options
- OperationOptions
Opzioni dell'operazione.
Restituisce
Promise<RegistrationDescription>
Descrizione della registrazione creata o aggiornata.
createRegistration(RegistrationDescription, OperationOptions)
Crea una nuova registrazione. Questo metodo genera un ID di registrazione, che è possibile usare successivamente per recuperare, aggiornare ed eliminare questa registrazione.
function createRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Parametri
- registration
- RegistrationDescription
Registrazione da creare.
- options
- OperationOptions
Opzioni per la creazione di una nuova registrazione.
Restituisce
Promise<RegistrationDescription>
Descrizione della registrazione appena creata.
createRegistrationId(OperationOptions)
Crea un nuovo ID registrazione.
function createRegistrationId(options?: OperationOptions): Promise<string>Parametri
- options
- OperationOptions
Opzioni per la creazione di un nuovo ID di registrazione.
Restituisce
Promise<string>
ID di registrazione appena creato.
deleteInstallation(string, OperationOptions)
Elimina un'installazione da un hub di notifica.
function deleteInstallation(installationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>Parametri
- installationId
-
string
ID di installazione dell'installazione da eliminare.
- options
- OperationOptions
Opzioni di configurazione per l'operazione di eliminazione dell'installazione.
Restituisce
Promise<NotificationHubsResponse>
NotificationHubResponse con l'ID di rilevamento, l'ID di correlazione e la posizione.
deleteRegistration(string, EntityOperationOptions)
Elimina una registrazione con l'ID di registrazione specificato.
function deleteRegistration(registrationId: string, options?: EntityOperationOptions): Promise<NotificationHubsResponse>Parametri
- registrationId
-
string
ID di registrazione della registrazione da eliminare.
- options
- EntityOperationOptions
Opzioni per le operazioni di eliminazione, incluso l'ETag
Restituisce
Promise<NotificationHubsResponse>
NotificationHubResponse con l'ID di rilevamento, l'ID di correlazione e la posizione.
getFeedbackContainerUrl(OperationOptions)
Recupera un URL del contenitore di Archiviazione di Azure. Il contenitore contiene dati di feedback per l'hub di notifica. Il chiamante può quindi usare Azure Storage Services SDK per recuperare il contenuto del contenitore.
function getFeedbackContainerUrl(options?: OperationOptions): Promise<string>Parametri
- options
- OperationOptions
Opzioni per ottenere l'URL del contenitore di commenti e suggerimenti per le notifiche push.
Restituisce
Promise<string>
URL del contenitore di archiviazione di Azure contenente i dati di feedback.
getInstallation(string, OperationOptions)
Ottiene un'installazione dell'hub di notifica di Azure in base all'ID di installazione.
function getInstallation(installationId: string, options?: OperationOptions): Promise<Installation>Parametri
- installationId
-
string
ID dell'installazione da ottenere.
- options
- OperationOptions
Opzioni di configurazione per l'operazione di installazione get.
Restituisce
Promise<Installation>
Installazione corrispondente all'ID di installazione.
getNotificationHubJob(string, OperationOptions)
Ottiene un processo dell'hub di notifica in base all'ID.
function getNotificationHubJob(jobId: string, options?: OperationOptions): Promise<NotificationHubJob>Parametri
- jobId
-
string
ID processo dell'hub di notifica.
- options
- OperationOptions
Opzioni dell'operazione.
Restituisce
Promise<NotificationHubJob>
Processo dell'hub di notifica con l'ID corrispondente.
getNotificationOutcomeDetails(string, OperationOptions)
Recupera i risultati di un'operazione di invio. In questo modo è possibile recuperare i risultati intermedi se l'invio viene elaborato o i risultati finali se l'oggetto Send* è stato completato. Questa API può essere chiamata solo per SKU Standard e versioni successive.
function getNotificationOutcomeDetails(notificationId: string, options?: OperationOptions): Promise<NotificationDetails>Parametri
- notificationId
-
string
ID di notifica restituito dall'operazione di invio.
- options
- OperationOptions
Opzioni dell'operazione.
Restituisce
Promise<NotificationDetails>
Risultati dell'operazione di invio.
getRegistration(string, OperationOptions)
Ottiene una registrazione in base all'ID di registrazione specificato.
function getRegistration(registrationId: string, options?: OperationOptions): Promise<RegistrationDescription>Parametri
- registrationId
-
string
ID della registrazione da ottenere.
- options
- OperationOptions
Opzioni per ottenere una registrazione in base all'ID.
Restituisce
Promise<RegistrationDescription>
RegistrationDescription con l'ID di registrazione specificato.
listNotificationHubJobs(OperationOptions)
Ottiene tutti i processi dell'hub di notifica per l'hub di notifica.
function listNotificationHubJobs(options?: OperationOptions): Promise<NotificationHubJob[]>Parametri
- options
- OperationOptions
Opzioni dell'operazione.
Restituisce
Promise<NotificationHubJob[]>
Matrice di tutti i processi dell'hub di notifica per questo hub di notifica.
listRegistrations(RegistrationQueryLimitOptions)
Ottiene tutte le registrazioni per l'hub di notifica con le opzioni di query specificate.
function listRegistrations(options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Parametri
- options
- RegistrationQueryLimitOptions
Opzioni per l'esecuzione di query sulle registrazioni, ad esempio $top.
Restituisce
Iterabile asincrona con paging contenente tutte le registrazioni per l'hub di notifica.
listRegistrationsByChannel(RegistrationChannel, RegistrationQueryLimitOptions)
Ottiene tutte le registrazioni per l'hub di notifica con le informazioni e le opzioni del dispositivo specificate.
function listRegistrationsByChannel(channel: RegistrationChannel, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Parametri
- channel
- RegistrationChannel
Informazioni sul canale di registrazione da eseguire per ogni tipo di PNS.
- options
- RegistrationQueryLimitOptions
Opzioni per l'esecuzione di query sulle registrazioni, ad esempio $top.
Restituisce
Iterabile asincrona con paging contenente tutte le registrazioni per l'hub di notifica.
listRegistrationsByTag(string, RegistrationQueryLimitOptions)
Elenca tutte le registrazioni con il tag corrispondente.
function listRegistrationsByTag(tag: string, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Parametri
- tag
-
string
Tag su cui eseguire una query per le registrazioni corrispondenti.
- options
- RegistrationQueryLimitOptions
Opzioni di query, ad esempio $top.
Restituisce
Iterabile asincrona con paging contenente le registrazioni corrispondenti per l'hub di notifica.
scheduleBroadcastNotification(Date, Notification, OperationOptions)
Pianifica una notifica push a tutti i dispositivi all'ora specificata. NOTA: questa opzione è disponibile solo in Hub di notifica di Azure CON SKU Standard.
function scheduleBroadcastNotification(scheduledTime: Date, notification: Notification, options?: OperationOptions): Promise<NotificationHubsMessageResponse>Parametri
- scheduledTime
-
Date
Data per inviare la notifica push.
- notification
- Notification
Notifica da inviare ai dispositivi corrispondenti.
- options
- OperationOptions
Opzioni dell'operazione.
Restituisce
Promise<NotificationHubsMessageResponse>
NotificationHubResponse con l'ID di rilevamento, l'ID di correlazione e la posizione.
scheduleNotification(Date, Notification, ScheduleNotificationOptions)
Pianifica una notifica push ai dispositivi che corrispondono ai tag o all'espressione di tag specificati all'ora specificata. NOTA: questa opzione è disponibile solo in Hub di notifica di Azure CON SKU Standard.
function scheduleNotification(scheduledTime: Date, notification: Notification, options: ScheduleNotificationOptions): Promise<NotificationHubsMessageResponse>Parametri
- scheduledTime
-
Date
Data per inviare la notifica push.
- notification
- Notification
Notifica da inviare ai dispositivi corrispondenti.
- options
- ScheduleNotificationOptions
Opzioni che includono tag usati per specificare come destinazione il dispositivo per le notifiche push in un'espressione di matrice o tag.
Restituisce
Promise<NotificationHubsMessageResponse>
NotificationHubResponse con l'ID di rilevamento, l'ID di correlazione e la posizione.
sendBroadcastNotification(Notification, BroadcastSendNotificationOptions)
Invia notifiche push a tutti i dispositivi.
function sendBroadcastNotification(notification: Notification, options?: BroadcastSendNotificationOptions): Promise<NotificationHubsMessageResponse>Parametri
- notification
- Notification
Notifica da inviare a tutti i dispositivi.
- options
- BroadcastSendNotificationOptions
Opzioni per la notifica, tra cui se abilitare l'invio di test.
Restituisce
Promise<NotificationHubsMessageResponse>
NotificationHubResponse con l'ID di rilevamento, l'ID di correlazione e la posizione.
sendNotification(Notification, DirectSendNotificationOptions | SendNotificationOptions)
Invia notifiche push ai dispositivi che corrispondono ai tag o all'espressione di tag specificati.
function sendNotification(notification: Notification, options: DirectSendNotificationOptions | SendNotificationOptions): Promise<NotificationHubsMessageResponse>Parametri
- notification
- Notification
Notifica da inviare ai dispositivi corrispondenti.
Opzioni per la notifica, inclusi tag, handle del dispositivo e se abilitare l'invio di test.
Restituisce
Promise<NotificationHubsMessageResponse>
NotificationHubResponse con l'ID di rilevamento, l'ID di correlazione e la posizione.
submitNotificationHubJob(NotificationHubJob, OperationOptions)
Invia un processo dell'hub di notifica. Si noti che è disponibile per lo spazio dei nomi SKU Standard e versioni successive.
function submitNotificationHubJob(job: NotificationHubJob, options?: OperationOptions): Promise<NotificationHubJob>Parametri
Processo dell'hub di notifica da inviare.
- options
- OperationOptions
Opzioni dell'operazione.
Restituisce
Promise<NotificationHubJob>
Dettagli del processo dell'hub di notifica, inclusi ID processo e stato.
updateInstallation(string, JsonPatch[], OperationOptions)
Aggiorna un'installazione usando lo standard JSON-Patch in RFC6902.
function updateInstallation(installationId: string, patches: JsonPatch[], options?: OperationOptions): Promise<NotificationHubsResponse>Parametri
- installationId
-
string
ID dell'installazione da aggiornare.
- patches
Matrice di patch che seguono lo standard JSON-Patch.
- options
- OperationOptions
Opzioni di configurazione per l'operazione di installazione delle patch.
Restituisce
Promise<NotificationHubsResponse>
NotificationHubResponse con l'ID di rilevamento, l'ID di correlazione e la posizione.
updateRegistration(RegistrationDescription, OperationOptions)
Aggiorna una registrazione esistente.
function updateRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Parametri
- registration
- RegistrationDescription
Registrazione da aggiornare.
- options
- OperationOptions
Opzioni dell'operazione.
Restituisce
Promise<RegistrationDescription>
Descrizione della registrazione aggiornata.