Exportar (0) Imprimir
Expandir Tudo

objeto apns

Atualizado: outubro de 2014

Permite que você envie notificações por push para um aplicativo iOS a partir de scripts do servidor de Serviços Móveis do Microsoft Azure usando Hubs de Notificação do Azure. A carga para uma notificação de APNS possui o seguinte formato JSON:

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

createNativeRegistration(token, tags, options, callback)
Cria um registro de APNS nativo.

Parâmetros

Nome Tipo Argumento Descrição

token

string

O token do dispositivo.

tags

cadeia de caracteres | matriz

Uma única marca ou matriz de marcas (lista separada por vírgulas, sem espaços).

options

objeto

<opcional>

As opções de solicitação ou a função de retorno de chamada.

callback

objeto

<opcional>

Um objeto JSON que especifica as funções de retorno de chamada success e error.

createOrUpdateNativeRegistration(registrationId, token, tags, options, callback)
Cria ou atualiza um registro de APNS nativo.

Parâmetros

Nome Tipo Argumento Descrição

registrationId

string

A identificação do registro.

token

string

O token do dispositivo.

tags

cadeia de caracteres | matriz

Uma única marca ou matriz de marcas (lista separada por vírgulas, sem espaços).

options

objeto

<opcional>

As opções de solicitação ou a função de retorno de chamada.

callback

objeto

<opcional>

Um objeto JSON que especifica as funções de retorno de chamada success e error.

createOrUpdateTemplateRegistration(registrationId, token, template, options, callback)
Cria ou atualiza um registro do modelo.

Parâmetros

Nome Tipo Argumento Descrição

registrationId

string

A identificação do registro.

token

string

O token do dispositivo.

template

cadeia de caracteres | matriz

A carga de JSON da mensagem conforme especificado abaixo.

Propriedades

Nome Tipo Argumento Descrição

notificação

number

<opcional>

O número a ser exibido sobre o ícone do aplicativo.

alerta

string

<opcional>

O texto do alerta.

som

string

<opcional>

O nome do arquivo de som.

carga

objeto

<opcional>

O objeto de carga que contém o texto da notificação.

data de expiração

date

<opcional>

A data de expiração.

Quando a carga for uma cadeia de caracteres, siga o formato de APNS.

options

objeto

<opcional>

As opções de solicitação ou a função de retorno de chamada.

callback

objeto

<opcional>

Um objeto JSON que especifica as funções de retorno de chamada success e error.

createTemplateRegistration(token, tags, template, options, callback)
Cria um registro do modelo.

Parâmetros

Nome Tipo Argumento Descrição

token

string

O token do dispositivo.

tags

cadeia de caracteres | matriz

Uma única marca ou matriz de marcas (lista separada por vírgulas, sem espaços).

template

cadeia de caracteres | matriz

A carga de JSON da mensagem conforme especificado abaixo.

Propriedades

Nome Tipo Argumento Descrição

notificação

number

<opcional>

O número a ser exibido sobre o ícone do aplicativo.

alerta

string

<opcional>

O texto do alerta.

som

string

<opcional>

O nome do arquivo de som.

carga

objeto

<opcional>

O objeto de carga que contém o texto da notificação.

data de expiração

date

<opcional>

A data de expiração.

Quando a carga for uma cadeia de caracteres, siga o formato de APNS.

options

objeto

<opcional>

As opções de solicitação ou a função de retorno de chamada.

callback

objeto

<opcional>

Um objeto JSON que especifica as funções de retorno de chamada success e error.

listRegistrationsByToken(token, options, callback)
Recupera um registro por um token do dispositivo.

Parâmetros

Nome Tipo Argumento Descrição

token

string

O token do dispositivo.

options

objeto

<opcional>

As opções de solicitação ou a função de retorno de chamada. As propriedades adicionais são passadas como cabeçalhos.

Propriedades

Nome Tipo Argumento Descrição

top

objeto

<opcional>

Especifica o número máximo de registro a obter a partir da chamada.

skip

objeto

<opcional>

Especifica o número de registros a ignorar na chamada.

callback

objeto

<opcional>

Um objeto JSON que especifica as funções de retorno de chamada success e error.

send(marcas, carga, retorno de chamada)
Envia uma notificação de APNS.

Parâmetros

Nome Tipo Descrição

tags

string

Uma única marca ou expressão de marcas. Quando é nulo, a mensagem é enviada para todos os registros do modelo.

payload

objeto | cadeia de caracteres

A carga de JSON da mensagem conforme especificado abaixo.

Propriedades

Nome Tipo Argumento Descrição

notificação

number

<opcional>

O número a ser exibido sobre o ícone do aplicativo.

alerta

string

<opcional>

O texto do alerta.

som

string

<opcional>

O nome do arquivo de som.

carga

objeto

<opcional>

O objeto de carga que contém o texto da notificação.

data de expiração

date

<opcional>

A data de expiração.

Quando a carga for uma cadeia de caracteres, siga o formato de APNS.

callback

objeto

Um objeto JSON que especifica as funções de retorno de chamada success e error.

updateTemplateRegistration(registrationId, token, template, options, callback)
Atualiza um registro do modelo existente.

Parâmetros

Nome Tipo Argumento Descrição

registrationId

string

A identificação do registro.

token

string

O token do dispositivo.

template

cadeia de caracteres | matriz

A carga de JSON da mensagem conforme especificado abaixo.

Propriedades

Nome Tipo Argumento Descrição

notificação

number

<opcional>

O número a ser exibido sobre o ícone do aplicativo.

alerta

string

<opcional>

O texto do alerta.

som

string

<opcional>

O nome do arquivo de som.

carga

objeto

<opcional>

O objeto de carga que contém o texto da notificação.

data de expiração

date

<opcional>

A data de expiração.

Quando a carga for uma cadeia de caracteres, siga o formato de APNS.

options

objeto

<opcional>

As opções de solicitação.

callback

objeto

Um objeto JSON que especifica as funções de retorno de chamada success e error.

Para obter um exemplo de como enviar notificações por push de seu serviço móvel para um aplicativo iOS, consulte Adicionar notificações por push ao seu aplicativo Serviços Móveis.

O objeto apns é obtido do objeto push em um script do servidor. Para obter um exemplo completo, consulte Introdução a notificações por push.

A carga para uma notificação de APNS possui o seguinte formato JSON:

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

Quando o campo alert do objeto payload estiver especificado, o valor de texto atribuído será exibido como uma notificação do sistema. Essa notificação será exibida mesmo quando o aplicativo não estiver em execução. Os dados no campo payload do objeto payload serão exibidos somente quando o aplicativo estiver sendo executado.

O exemplo a seguir chama o método send para enviar uma notificação de texto para um dispositivo específico quando um novo item é inserido em uma tabela.

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

Mostrar:
© 2014 Microsoft