Exportar (0) Imprimir
Expandir Tudo
Este tópico ainda não foi avaliado como - Avalie este tópico

objeto apns

Atualizado: fevereiro de 2013

Expõe a funcionalidade da Notificação por Push da Apple (APNS) em scripts do servidor do Serviços Móveis do Windows Azure.

O objeto apns tem os seguintes métodos:

send

Envia uma notificação para um dispositivo específico.

Sintaxe

apns.send(deviceToken, payload, options)

Parâmetros

 

Parâmetro Descrição

deviceToken

Valor de token obrigatório que indica qual dispositivo recebe a notificação.

payload

O objeto necessário que contém as informações de notificação, no seguinte formato:

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

Onde badge_number é o número a ser exibido no ícone do aplicativo, alert_text é a mensagem de alerta do sistema, sound_file é o som a ser executado quando a notificação é recebida, payload_object é um objeto JSON que contém o texto da mensagem de notificação e expire_date é a data depois da qual a notificação não é mais entregue.

options

Objeto opcional que especifica a função de manipulador de erro, no seguinte formato:

{
    error : function(err) {
        // handle the error here.
    }
}

A saída de erro fornecida para o retorno de chamada tem o seguinte formato:

{
    statusCode : error_status,
    deviceToken : 'device_token',
    statusDescription : 'error_description' 
}

Onde error_status é o código de status para o erro, device_token indica qual dispositivo gerou o erro e error_description é uma descrição de texto do erro.

Retorna

Indefinido.

getFeedback

Usado para solicitar informações do APNS sobre falhas de notificação por push específicas de dispositivo.

Sintaxe

apns.getFeedback(completion)

Parâmetros

 

Parâmetro Descrição

completion

Um objeto de conclusão que tem manipuladores success e error, da seguinte maneira:

{
    success: function(devices) {
        // Code that executes when the method succeeds.
    },
    error: function(err) {
        // Code that executes when the method fails.
    }
}

Quando um manipulador de erro não é fornecido, os erros são gravados no log.

O objeto de saída devices está no seguinte formato:

[ 
    { 
        deviceToken : 'device_token1', 
        timeStamp : 'time_stamp_datetime1'
    },
{ 
        deviceToken : 'device_token2', 
        timeStamp : 'time_stamp_datetime2'
    },
    { n }
]

Retorna

Indefinido.

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.

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 APNS rastreia as notificações com falhas devidas a ausência de aplicativos no dispositivo. O Serviços Móveis permite que você acesse essas informações do serviço de comentários do APNS e remova os tokens do dispositivo, de modo que você não incorra em custos adicionais para enviar notificações a aplicativos que não estão instalados. Para isso, o Serviços Móveis chama periodicamente a função processFeedback. Nessa função, você pode chamar o método getFeedback no objeto apns. Esse método retorna uma matriz de objetos que representa as falhas, onde cada objeto apresenta os campos deviceToken e timeStamp. A matriz de dispositivos é retornada no manipulador success:. Quando um manipulador de erro não é fornecido, os erros são gravados no log do seu serviço móvel.

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({
        success: function() {
            // Write to the response and then send the push notification.
            request.respond();
            push.apns.send(item.deviceToken, {
                payload: { itemText: item.text, userId: user.userId } 
            });
        }
    });
}

O script processFeedback a seguir é chamado pelos Serviços Móveis e usado para executar o método getFeedback.

function processFeedback() {

    push.apns.getFeedback({
        success: function(results) {
            // results will be an array of objects, each with 'deviceToken' and 'time' properties
            if (results.length > 0) {
                  // TODO - update your storage to mark or delete devices appropriately
                  console.warn("APNS feedback received for the following device tokens.",  results);
            }
        }
    });
}

Isso foi útil para você?
(1500 caracteres restantes)
Agradecemos os seus comentários
Mostrar:
© 2014 Microsoft. Todos os direitos reservados.