Exporter (0) Imprimer
Développer tout

apns (objet)

Mis à jour: février 2013

Expose les fonctionnalités des services de notification Push Apple (APNS) dans des scripts de serveur Windows Azure Mobile Services.

L'objet apns contient les méthodes suivantes :

send

Envoie une notification à un appareil spécifique.

Syntaxe

apns.send(deviceToken, payload, options)

Paramètres

 

Parameter Description

deviceToken

Valeur de jeton requise qui indique quel appareil reçoit la notification.

payload

Objet requis qui contient les informations de notification, au format suivant :

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

badge_number est le nombre à afficher sur l'icône d'application, alert_text est le message d'alerte de toast, sound_file est le son à diffuser lors de la réception de la notification, payload_object est un objet JSON qui contient le texte de notification et expire_date est la date après laquelle la notification n'est plus remise.

options

Objet facultatif qui spécifie la fonction du gestionnaire d'erreurs, au format suivant :

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

La sortie d'erreur fournie au rappel a le format suivant :

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

error_status est le code d'état de l'erreur, device_token indique quel appareil a généré l'erreur et error_description est une description textuelle de l'erreur.

Valeurs de retour

Non défini.

getFeedback

Utilisé pour demander des informations de l'APNS sur les erreurs de notification push spécifiques à l'appareil.

Syntaxe

apns.getFeedback(completion)

Paramètres

 

Parameter Description

completion

Objet d'achèvement qui a les gestionnaires success et error, comme suit :

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

Lorsqu'aucun gestionnaire d'erreurs n'est fourni, les erreurs sont écrites dans le journal.

L'objet de sortie devices est au format suivant :

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

Valeurs de retour

Non défini.

L'objet apns est obtenu à partir de l'push (objet) dans un script de serveur. Pour obtenir un exemple complet, consultez les aspects relatifs à la prise en main des notifications Push.

Lorsque le champ alert de l'objet payload est spécifié, la valeur de texte affectée s'affiche comme notification toast. Cette notification s'affiche même lorsque l'application n'est pas en cours d'exécution. Les données du champ payload de l'objet payload s'affichent uniquement lorsque l'application est en cours d'exécution.

Les Services de notifications Push Apple (APNS) effectuent le suivi des notifications qui échouent en raison de la désinstallation de l'application sur l'appareil. Mobiles Services vous donne accès à ces informations dans le service de signalement des problèmes APNS et supprime les jetons d'appareil pour vous permettre d'éviter le coût supplémentaire lié à l'envoi de notifications à des applications désinstallées. Pour ce faire, Mobiles Services appelle régulièrement la fonction processFeedback. Dans cette fonction, appelez la méthode getFeedback sur l'objet apns. Cette méthode retourne un tableau d'objets qui représentent des échecs, où chaque objet comporte les champs deviceToken et timeStamp. Le tableau d'appareils est retourné dans le gestionnaire success:. Lorsqu'aucun gestionnaire d'erreurs n'est fourni, les erreurs sont écrites dans le journal du service mobile.

L'exemple suivant appelle la méthode send pour envoyer une notification texte à un appareil spécifique lorsqu'un nouvel élément est inséré dans une table.

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 } 
            });
        }
    });
}

Le script processFeedback suivant est appelé par les services mobiles et est utilisé pour exécuter la méthode 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);
            }
        }
    });
}

Afficher:
© 2014 Microsoft