NotificationHubsClient class
Это представляет клиент для Центров уведомлений Azure для управления установками и отправкой сообщений на устройства.
Конструкторы
| Notification |
Создает новый экземпляр NotificationClient со строкой подключения, именем концентратора и параметрами. |
Методы
| begin |
Отправляет задание Центра уведомлений и создает опрашиватель для опроса результатов. |
| cancel |
Отменяет запланированное уведомление с указанным идентификатором уведомления. |
| create |
Создает или перезаписывает установку в Центр уведомлений. |
| create |
Создает или обновляет регистрацию. |
| create |
Создает новую регистрацию. Этот метод создает идентификатор регистрации, который впоследствии можно использовать для получения, обновления и удаления этой регистрации. |
| create |
Создает новый идентификатор регистрации. |
| delete |
Удаляет установку из Центра уведомлений. |
| delete |
Удаляет регистрацию с указанным идентификатором регистрации. |
| get |
Извлекает URL-адрес контейнера службы хранилища Azure. Контейнер содержит данные обратной связи для концентратора уведомлений. Затем вызывающий объект может использовать пакет SDK служб хранилища Azure для получения содержимого контейнера. |
| get |
Возвращает установку Центра уведомлений Azure по идентификатору установки. |
| get |
Возвращает задание Центра уведомлений по идентификатору. |
| get |
Извлекает результаты операции отправки. Это может получить промежуточные результаты, если отправка обрабатывается или конечные результаты, если отправка завершена. Этот API можно вызывать только для номера SKU уровня "Стандартный" и выше. |
| get |
Получает регистрацию по указанному идентификатору регистрации. |
| list |
Возвращает все задания Концентратора уведомлений для этого центра уведомлений. |
| list |
Возвращает все регистрации для концентратора уведомлений с заданными параметрами запроса. |
| list |
Получает все регистрации для центра уведомлений с заданными сведениями об устройстве и параметрами. |
| list |
Выводит список всех регистраций с соответствующим тегом. |
| schedule |
Запланирует push-уведомление на все устройства в указанное время. ПРИМЕЧАНИЕ. Это доступно только в Центрах уведомлений Azure уровня "Стандартный". |
| schedule |
Запланирует push-уведомление на устройства, соответствующие заданным тегам или выражению тегов в указанное время. ПРИМЕЧАНИЕ. Это доступно только в Центрах уведомлений Azure уровня "Стандартный". |
| send |
Отправляет push-уведомления на устройства всех устройствах. |
| send |
Отправляет push-уведомления на устройства, соответствующие заданным тегам или выражению тегов. |
| submit |
Отправляет задание Центра уведомлений. Обратите внимание, что это доступно для пространства имен SKU уровня "Стандартный" и выше. |
| update |
Обновляет установку, используя стандарт JSON-Patch в RFC6902. |
| update |
Обновляет существующую регистрацию. |
Сведения о конструкторе
NotificationHubsClient(string, string, NotificationHubsClientOptions)
Создает новый экземпляр NotificationClient со строкой подключения, именем концентратора и параметрами.
new NotificationHubsClient(connectionString: string, hubName: string, options?: NotificationHubsClientOptions)Параметры
- connectionString
-
string
Строка подключения политики доступа центра уведомлений.
- hubName
-
string
Имя Центра уведомлений Azure.
- options
- NotificationHubsClientOptions
Параметры настройки клиента Центров уведомлений Azure.
Сведения о методе
beginSubmitNotificationHubJob(NotificationHubJob, PolledOperationOptions)
Отправляет задание Центра уведомлений и создает опрашиватель для опроса результатов.
function beginSubmitNotificationHubJob(notificationHubJob: NotificationHubJob, options?: PolledOperationOptions): Promise<NotificationHubJobPoller>Параметры
- notificationHubJob
- NotificationHubJob
Задание импорта и экспорта центра уведомлений для запуска.
- options
- PolledOperationOptions
Параметры операции.
Возвращаемое значение
Promise<NotificationHubJobPoller>
Средство опроса, которое можно вызвать для опроса до завершения задания.
cancelScheduledNotification(string, OperationOptions)
Отменяет запланированное уведомление с указанным идентификатором уведомления.
function cancelScheduledNotification(notificationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>Параметры
- notificationId
-
string
Идентификатор уведомления из запланированного уведомления.
- options
- OperationOptions
Параметры операции.
Возвращаемое значение
Promise<NotificationHubsResponse>
Ответ концентратора уведомлений с идентификатором корреляции и идентификатором отслеживания.
createOrUpdateInstallation(Installation, OperationOptions)
Создает или перезаписывает установку в Центр уведомлений.
function createOrUpdateInstallation(installation: Installation, options?: OperationOptions): Promise<NotificationHubsResponse>Параметры
- installation
- Installation
Установка для создания или перезаписи.
- options
- OperationOptions
Параметры конфигурации для операции создания или обновления установки.
Возвращаемое значение
Promise<NotificationHubsResponse>
NotificationHubResponse с идентификатором отслеживания, идентификатором корреляции и расположением.
createOrUpdateRegistration(RegistrationDescription, OperationOptions)
Создает или обновляет регистрацию.
function createOrUpdateRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Параметры
- registration
- RegistrationDescription
Регистрация для создания или обновления.
- options
- OperationOptions
Параметры операции.
Возвращаемое значение
Promise<RegistrationDescription>
Созданное или обновленное описание регистрации.
createRegistration(RegistrationDescription, OperationOptions)
Создает новую регистрацию. Этот метод создает идентификатор регистрации, который впоследствии можно использовать для получения, обновления и удаления этой регистрации.
function createRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Параметры
- registration
- RegistrationDescription
Регистрация для создания.
- options
- OperationOptions
Параметры создания новой регистрации.
Возвращаемое значение
Promise<RegistrationDescription>
Только что созданное описание регистрации.
createRegistrationId(OperationOptions)
Создает новый идентификатор регистрации.
function createRegistrationId(options?: OperationOptions): Promise<string>Параметры
- options
- OperationOptions
Параметры создания нового идентификатора регистрации.
Возвращаемое значение
Promise<string>
Созданный идентификатор регистрации.
deleteInstallation(string, OperationOptions)
Удаляет установку из Центра уведомлений.
function deleteInstallation(installationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>Параметры
- installationId
-
string
Идентификатор установки для удаления.
- options
- OperationOptions
Параметры конфигурации для операции удаления установки.
Возвращаемое значение
Promise<NotificationHubsResponse>
NotificationHubResponse с идентификатором отслеживания, идентификатором корреляции и расположением.
deleteRegistration(string, EntityOperationOptions)
Удаляет регистрацию с указанным идентификатором регистрации.
function deleteRegistration(registrationId: string, options?: EntityOperationOptions): Promise<NotificationHubsResponse>Параметры
- registrationId
-
string
Идентификатор регистрации для удаления.
- options
- EntityOperationOptions
Параметры операций удаления, включая ETag
Возвращаемое значение
Promise<NotificationHubsResponse>
NotificationHubResponse с идентификатором отслеживания, идентификатором корреляции и расположением.
getFeedbackContainerUrl(OperationOptions)
Извлекает URL-адрес контейнера службы хранилища Azure. Контейнер содержит данные обратной связи для концентратора уведомлений. Затем вызывающий объект может использовать пакет SDK служб хранилища Azure для получения содержимого контейнера.
function getFeedbackContainerUrl(options?: OperationOptions): Promise<string>Параметры
- options
- OperationOptions
Параметры получения URL-адреса контейнера отзывов push-уведомлений.
Возвращаемое значение
Promise<string>
URL-адрес контейнера службы хранилища Azure, содержащего данные обратной связи.
getInstallation(string, OperationOptions)
Возвращает установку Центра уведомлений Azure по идентификатору установки.
function getInstallation(installationId: string, options?: OperationOptions): Promise<Installation>Параметры
- installationId
-
string
Идентификатор установки, который требуется получить.
- options
- OperationOptions
Параметры конфигурации для операции получения установки.
Возвращаемое значение
Promise<Installation>
Установка, соответствующая идентификатору установки.
getNotificationHubJob(string, OperationOptions)
Возвращает задание Центра уведомлений по идентификатору.
function getNotificationHubJob(jobId: string, options?: OperationOptions): Promise<NotificationHubJob>Параметры
- jobId
-
string
Идентификатор задания Центра уведомлений.
- options
- OperationOptions
Параметры операции.
Возвращаемое значение
Promise<NotificationHubJob>
Задание Центра уведомлений с соответствующим идентификатором.
getNotificationOutcomeDetails(string, OperationOptions)
Извлекает результаты операции отправки. Это может получить промежуточные результаты, если отправка обрабатывается или конечные результаты, если отправка завершена. Этот API можно вызывать только для номера SKU уровня "Стандартный" и выше.
function getNotificationOutcomeDetails(notificationId: string, options?: OperationOptions): Promise<NotificationDetails>Параметры
- notificationId
-
string
Идентификатор уведомления, возвращенный из операции отправки.
- options
- OperationOptions
Параметры операции.
Возвращаемое значение
Promise<NotificationDetails>
Результаты операции отправки.
getRegistration(string, OperationOptions)
Получает регистрацию по указанному идентификатору регистрации.
function getRegistration(registrationId: string, options?: OperationOptions): Promise<RegistrationDescription>Параметры
- registrationId
-
string
Идентификатор получения регистрации.
- options
- OperationOptions
Параметры получения регистрации по идентификатору.
Возвращаемое значение
Promise<RegistrationDescription>
Идентификатор регистрации, имеющий заданный идентификатор регистрации.
listNotificationHubJobs(OperationOptions)
Возвращает все задания Концентратора уведомлений для этого центра уведомлений.
function listNotificationHubJobs(options?: OperationOptions): Promise<NotificationHubJob[]>Параметры
- options
- OperationOptions
Параметры операции.
Возвращаемое значение
Promise<NotificationHubJob[]>
Массив всех заданий Концентратора уведомлений для этого центра уведомлений.
listRegistrations(RegistrationQueryLimitOptions)
Возвращает все регистрации для концентратора уведомлений с заданными параметрами запроса.
function listRegistrations(options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Параметры
- options
- RegistrationQueryLimitOptions
Параметры запроса регистраций, таких как $top.
Возвращаемое значение
Страница с асинхронной итерируемой возможностью, содержащей все регистрации для концентратора уведомлений.
listRegistrationsByChannel(RegistrationChannel, RegistrationQueryLimitOptions)
Получает все регистрации для центра уведомлений с заданными сведениями об устройстве и параметрами.
function listRegistrationsByChannel(channel: RegistrationChannel, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Параметры
- channel
- RegistrationChannel
Сведения о канале регистрации для запроса для каждого типа PNS.
- options
- RegistrationQueryLimitOptions
Параметры запроса регистраций, таких как $top.
Возвращаемое значение
Страница с асинхронной итерируемой возможностью, содержащей все регистрации для концентратора уведомлений.
listRegistrationsByTag(string, RegistrationQueryLimitOptions)
Выводит список всех регистраций с соответствующим тегом.
function listRegistrationsByTag(tag: string, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription, RegistrationDescription[], PageSettings>Параметры
- tag
-
string
Тег для запроса для сопоставления регистраций.
- options
- RegistrationQueryLimitOptions
Параметры запроса, такие как $top.
Возвращаемое значение
Страница асинхронная итерабельная, содержащая соответствующие регистрации для концентратора уведомлений.
scheduleBroadcastNotification(Date, Notification, OperationOptions)
Запланирует push-уведомление на все устройства в указанное время. ПРИМЕЧАНИЕ. Это доступно только в Центрах уведомлений Azure уровня "Стандартный".
function scheduleBroadcastNotification(scheduledTime: Date, notification: Notification, options?: OperationOptions): Promise<NotificationHubsMessageResponse>Параметры
- scheduledTime
-
Date
Дата отправки push-уведомления.
- notification
- Notification
Уведомление для отправки на соответствующие устройства.
- options
- OperationOptions
Параметры операции.
Возвращаемое значение
Promise<NotificationHubsMessageResponse>
NotificationHubResponse с идентификатором отслеживания, идентификатором корреляции и расположением.
scheduleNotification(Date, Notification, ScheduleNotificationOptions)
Запланирует push-уведомление на устройства, соответствующие заданным тегам или выражению тегов в указанное время. ПРИМЕЧАНИЕ. Это доступно только в Центрах уведомлений Azure уровня "Стандартный".
function scheduleNotification(scheduledTime: Date, notification: Notification, options: ScheduleNotificationOptions): Promise<NotificationHubsMessageResponse>Параметры
- scheduledTime
-
Date
Дата отправки push-уведомления.
- notification
- Notification
Уведомление для отправки на соответствующие устройства.
- options
- ScheduleNotificationOptions
Параметры, которые включают теги, используемые для назначения устройству для push-уведомлений в массиве или выражении тегов.
Возвращаемое значение
Promise<NotificationHubsMessageResponse>
NotificationHubResponse с идентификатором отслеживания, идентификатором корреляции и расположением.
sendBroadcastNotification(Notification, BroadcastSendNotificationOptions)
Отправляет push-уведомления на устройства всех устройствах.
function sendBroadcastNotification(notification: Notification, options?: BroadcastSendNotificationOptions): Promise<NotificationHubsMessageResponse>Параметры
- notification
- Notification
Уведомление для отправки на все устройства.
- options
- BroadcastSendNotificationOptions
Параметры уведомления, включая включение тестовой отправки.
Возвращаемое значение
Promise<NotificationHubsMessageResponse>
NotificationHubResponse с идентификатором отслеживания, идентификатором корреляции и расположением.
sendNotification(Notification, DirectSendNotificationOptions | SendNotificationOptions)
Отправляет push-уведомления на устройства, соответствующие заданным тегам или выражению тегов.
function sendNotification(notification: Notification, options: DirectSendNotificationOptions | SendNotificationOptions): Promise<NotificationHubsMessageResponse>Параметры
- notification
- Notification
Уведомление для отправки на соответствующие устройства.
Параметры уведомления, включая теги, дескриптор устройства и возможность отправки тестов.
Возвращаемое значение
Promise<NotificationHubsMessageResponse>
NotificationHubResponse с идентификатором отслеживания, идентификатором корреляции и расположением.
submitNotificationHubJob(NotificationHubJob, OperationOptions)
Отправляет задание Центра уведомлений. Обратите внимание, что это доступно для пространства имен SKU уровня "Стандартный" и выше.
function submitNotificationHubJob(job: NotificationHubJob, options?: OperationOptions): Promise<NotificationHubJob>Параметры
Задание центра уведомлений для отправки.
- options
- OperationOptions
Параметры операции.
Возвращаемое значение
Promise<NotificationHubJob>
Сведения о задании центра уведомлений, включая идентификатор задания и состояние.
updateInstallation(string, JsonPatch[], OperationOptions)
Обновляет установку, используя стандарт JSON-Patch в RFC6902.
function updateInstallation(installationId: string, patches: JsonPatch[], options?: OperationOptions): Promise<NotificationHubsResponse>Параметры
- installationId
-
string
Идентификатор установки для обновления.
- patches
Массив исправлений после JSON-Patch стандарта.
- options
- OperationOptions
Параметры конфигурации для операции установки исправлений.
Возвращаемое значение
Promise<NotificationHubsResponse>
NotificationHubResponse с идентификатором отслеживания, идентификатором корреляции и расположением.
updateRegistration(RegistrationDescription, OperationOptions)
Обновляет существующую регистрацию.
function updateRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>Параметры
- registration
- RegistrationDescription
Регистрация для обновления.
- options
- OperationOptions
Параметры операции.
Возвращаемое значение
Promise<RegistrationDescription>
Обновленное описание регистрации.