Экспорт (0) Печать
Развернуть все

объект APNS

Обновлено: Февраль 2015 г.

Позволяет отправлять push-уведомления в приложение iOS из скриптов сервера Мобильные службы Microsoft Azure с использованием концентраторов уведомлений Azure. Полезные данные уведомления APNS имеют следующий формат JSON:

{
    aps: {
        badge: badge_number,
        alert: 'alert_text',
        sound: 'sound_file',
        payload: payload_object,
        expiry: expire_date
    }
}

createNativeRegistration(token, tags, options, callback)
Создает собственную регистрацию APNS.

Параметры

Название Type Аргумент Описание

token

строка

Токен устройства.

tags

строка | массив

Один тег или массив тегов (список с разделителями-запятыми, без пробелов).

options

объект

<необязательный>

Параметры запроса или функция обратного вызова.

callback

объект

<необязательный>

JSON-объект, который задает функции обратного вызова success и error.

createOrUpdateNativeRegistration(registrationId, token, tags, options, callback)
Создает или обновляет собственную регистрацию APNS.

Параметры

Название Type Аргумент Описание

registrationId

строка

Идентификатор регистрации.

token

строка

Токен устройства.

tags

строка | массив

Один тег или массив тегов (список с разделителями-запятыми, без пробелов).

options

объект

<необязательный>

Параметры запроса или функция обратного вызова.

callback

объект

<необязательный>

JSON-объект, который задает функции обратного вызова success и error.

createOrUpdateTemplateRegistration(registrationId, token, template, options, callback)
Создает или обновляет регистрацию шаблона.

Параметры

Название Type Аргумент Описание

registrationId

строка

Идентификатор регистрации.

token

строка

Токен устройства.

template

строка | массив

Полезные данные JSON для сообщения, как указано ниже.

Свойства

Название Type Аргумент Описание

badge

number

<необязательный>

Значение, отображаемое над значком приложения.

предупреждение

строка

<необязательный>

Текст предупреждения.

sound

строка

<необязательный>

Имя звукового файла.

payload

объект

<необязательный>

Объект, содержащий текст уведомления.

expiry

date

<необязательный>

Дата окончания срока действия.

Если полезные данные являются строкой, используйте формат APNS.

options

объект

<необязательный>

Параметры запроса или функция обратного вызова.

callback

объект

<необязательный>

JSON-объект, который задает функции обратного вызова success и error.

createTemplateRegistration(token, tags, template, options, callback)
Создает регистрацию шаблона.

Параметры

Название Type Аргумент Описание

token

строка

Токен устройства.

tags

строка | массив

Один тег или массив тегов (список с разделителями-запятыми, без пробелов).

template

строка | массив

Полезные данные JSON для сообщения, как указано ниже.

Свойства

Название Type Аргумент Описание

badge

number

<необязательный>

Значение, отображаемое над значком приложения.

предупреждение

строка

<необязательный>

Текст предупреждения.

sound

строка

<необязательный>

Имя звукового файла.

payload

объект

<необязательный>

Объект, содержащий текст уведомления.

expiry

date

<необязательный>

Дата окончания срока действия.

Если полезные данные являются строкой, используйте формат APNS.

options

объект

<необязательный>

Параметры запроса или функция обратного вызова.

callback

объект

<необязательный>

JSON-объект, который задает функции обратного вызова success и error.

listRegistrationsByToken(token, options, callback)
Извлекает регистрацию по токену устройства.

Параметры

Название Type Аргумент Описание

token

строка

Токен устройства.

options

объект

<необязательный>

Параметры запроса или функция обратного вызова. Дополнительные свойства передаются как заголовки.

Свойства

Название Type Аргумент Описание

наибольшее

объект

<необязательный>

Определяет максимальное количество регистраций для получения из вызова.

skip

объект

<необязательный>

Определяет количество регистраций для пропуска в вызове.

callback

объект

<необязательный>

JSON-объект, который задает функции обратного вызова success и error.

отправка(теги, полезные данные, обратный вызов)
Отправляет уведомление APNS.

Параметры

Название Type Описание

tags

строка

Один тег или выражение тегов. При значении null сообщение отправляется всем регистрациям шаблона.

payload

объект | строка

Полезные данные JSON для сообщения, как указано ниже.

Свойства

Название Type Аргумент Описание

badge

number

<необязательный>

Значение, отображаемое над значком приложения.

предупреждение

строка

<необязательный>

Текст предупреждения.

sound

строка

<необязательный>

Имя звукового файла.

payload

объект

<необязательный>

Объект, содержащий текст уведомления.

expiry

date

<необязательный>

Дата окончания срока действия.

Если полезные данные являются строкой, используйте формат APNS.

callback

объект

JSON-объект, который задает функции обратного вызова success и error.

updateTemplateRegistration(registrationId, token, template, options, callback)
Обновляет существующую регистрацию шаблона.

Параметры

Название Type Аргумент Описание

registrationId

строка

Идентификатор регистрации.

token

строка

Токен устройства.

template

строка | массив

Полезные данные JSON для сообщения, как указано ниже.

Свойства

Название Type Аргумент Описание

badge

number

<необязательный>

Значение, отображаемое над значком приложения.

предупреждение

строка

<необязательный>

Текст предупреждения.

sound

строка

<необязательный>

Имя звукового файла.

payload

объект

<необязательный>

Объект, содержащий текст уведомления.

expiry

date

<необязательный>

Дата окончания срока действия.

Если полезные данные являются строкой, используйте формат APNS.

options

объект

<необязательный>

Параметры запроса.

callback

объект

JSON-объект, который задает функции обратного вызова success и error.

Пример отправки push-уведомления из мобильной службы в приложение iOS см. в разделе Добавление push-уведомлений в приложение мобильных служб.

Объект apns берется из объект push в серверном скрипте. Полный пример см. в разделе Приступая к работе с push-уведомлениями.

Полезные данные уведомления APNS имеют следующий формат JSON:

{
    aps: {
        badge: badge_number,
        alert: 'alert_text',
        sound: 'sound_file',
        payload: payload_object,
        expiry: expire_date
    }
}

Если указано поле alert объекта payload, присвоенное значение текста отображается как всплывающее уведомление. Это уведомление отображается, даже если приложение не выполняется. Данные в поле payload объекта payload отображаются, только если приложение выполняется.

В следующем примере вызывается метод send для отправки текстового уведомления определенному устройству при вставке нового элемента в таблицу.

function insert(item, user, request) {
    request.execute();
    push.apns.send(null, {
        alert: "Alert: " + item.text,
        payload: {
            inAppMessage: "Hey, a new item arrived: '" + item.text + "'"
        }
    });
}

Показ:
© 2015 Microsoft