Exportar (0) Imprimir
Expandir todo

wns (objeto)

Actualizado: marzo de 2012

Expone la funcionalidad del Servicio de notificaciones de inserción de Windows (WNS) en scripts de servidor de Servicios móviles de Windows Azure.

Este objeto contiene los métodos y los conjuntos de métodos siguientes que se usan para enviar notificaciones:

sendTile*

Envía una notificación de mosaico a un canal específico, donde cada versión del método sendTile* emplea otra plantilla de mosaico de WNS.

Sintaxis

Parámetros

 

Parámetro Descripción

channel

Valor de URI de canal o matriz de valores de URI necesarios que indican los canales que van a recibir la notificación.

payload

Objeto necesario que contiene la información de notificación, donde los campos necesarios dependen de la plantilla de la notificación específica. Por ejemplo, al llamar al método sendTileWideImageAndText02, se proporciona un objeto payload con los campos siguientes:

{
    text1: 'text field 1',
    text2: 'text field 2',
    image1src: 'image1.png',
    image1alt: 'alt text'
}

Vea las notas para obtener información sobre cómo ordenar y asignar nombre a los campos en el objeto payload.

options

Objeto que se emplea para proporcionar las devoluciones de llamada de operación correcta y con errores, y otros comportamientos opcionales de la notificación:

{
    success: success,
    error: error,
    headers: wns_headers 
}

Donde success es la función a la que se llama después de enviarse la notificación, error es la función a la que se llama cuando se produce un error y headers es la lista de todos los encabezados de solicitud HTTP adicionales que se van a incluir en la solicitud enviada a WNS.

Para obtener una lista de los encabezados de solicitud HTTP disponibles, vea Push notification service request and response headers.

Devuelve

Sin definir.

sendToast*

Envía una notificación del sistema a un canal específico, donde cada versión del método sendToast* emplea otra plantilla.

Sintaxis

wns.sendToast*(channel, payload, options)

El asterisco (*) es un marcador de posición para una de las plantillas de mosaico, que se muestran a continuación:

Parámetros

 

Parámetro Descripción

channel

Valor de URI de canal o matriz de valores de URI necesarios que indican los canales que van a recibir la notificación.

payload

Objeto necesario que contiene la información de notificación, donde los campos necesarios dependen de la plantilla de la notificación específica. Por ejemplo, al llamar al método sendToastImageAndText03, se proporciona un objeto payload con los campos siguientes:

{
    text1: 'headline text',
    text2: 'body text',
    image1src: 'image1.png',
    image1alt: 'alt text'
}

Vea las notas para obtener información sobre cómo ordenar y asignar nombre a los campos en el objeto payload.

options

Objeto que se emplea para proporcionar las devoluciones de llamada de operación correcta y con errores, y otros comportamientos opcionales de la notificación:

{
    success: success,
    error: error,
    headers: wns_headers, 
    launch: launch_uri,
    duration: duration_time 
}

Donde success es la función a la que se llama después de enviarse la notificación, error es la función a la que se llama cuando se produce un error, headers es la lista de todos los encabezados de solicitud HTTP adicionales que se van a incluir en la solicitud enviada a WNS, launch_uri es un URI opcional al que se navegará cuando se genere la notificación del sistema y duration_time es el período de tiempo que se muestra la notificación del sistema.

Para obtener una lista de los encabezados de solicitud HTTP disponibles, vea Push notification service request and response headers.

Los valores válidos para el campo duration_time son long y short.

Devuelve

Sin definir.

sendBadge

Envía una notificación informativa a un canal determinado.

Sintaxis

wns.sendBadge(channel, value, options)

Parámetros

 

Parámetro Descripción

channel

Valor de URI de canal o matriz de valores de URI necesarios que indican los canales que van a recibir la notificación.

value

Valor numérico o de cadena que especifica un glifo distintivo predefinido. Numéricamente, este valor puede aceptar cualquier entero válido. El valor de 0 borra el distintivo, los valores entre 1 y 99 se muestran según se indica, y los valores mayores que 99 se muestran como más de 99. Entre los valores de cadena admitidos se incluyen los siguientes:

  • Ninguno

  • activity

  • alerta

  • disponible

  • away

  • busy

  • newMessage

  • en pausa

  • playing

  • unavailable

  • error

  • attention

Para obtener más información, vea Badge schema.

options

Objeto que se emplea para proporcionar las devoluciones de llamada de operación correcta y con errores, y otros comportamientos opcionales de la notificación:

{
    success: success,
    error: error,
    headers: wns_headers, 
}

Donde success es la función a la que se llama después de enviarse la notificación, error es la función a la que se llama cuando se produce un error y headers es la lista de todos los encabezados de solicitud HTTP adicionales que se van a incluir en la solicitud enviada a WNS.

Para obtener una lista de los encabezados de solicitud HTTP disponibles, vea Push notification service request and response headers.

Devuelve

Sin definir.

sendRaw

Envía una notificación sin procesar a un canal determinado.

Sintaxis

wns.sendRaw(channel, value, options)

Parámetros

 

Parámetro Descripción

channel

Valor de URI de canal o matriz de valores de URI necesarios que indican los canales que van a recibir la notificación.

value

Cadena específica de la aplicación que se entrega al cliente sin modificación alguna.

options

Objeto que se emplea para proporcionar las devoluciones de llamada de operación correcta y con errores, y otros comportamientos opcionales de la notificación:

{
    success: success,
    error: error,
    headers: wns_headers, 
}

Donde success es la función a la que se llama después de enviarse la notificación, error es la función a la que se llama cuando se produce un error y headers es la lista de todos los encabezados de solicitud HTTP adicionales que se van a incluir en la solicitud enviada a WNS.

Para obtener una lista de los encabezados de solicitud HTTP disponibles, vea Push notification service request and response headers.

Devuelve

Sin definir.

send

Envía una notificación con formato previo a un canal determinado.

ImportantImportante
Para usar este método, debe conocer el formato de carga concreto del tipo de notificación seleccionado.

Sintaxis

wns.send(channel, payload, type, value, options)

Parámetros

 

Parámetro Descripción

channel

Valor de URI de canal o matriz de valores de URI necesarios que indican los canales que van a recibir la notificación.

payload

Cadena específica de la aplicación que se entrega al cliente sin modificación alguna.

Examine los temas sobre las notificaciones de inserción en la documentación de las aplicaciones de la Tienda Windows para obtener información acerca de los formatos de carga. Para obtener más información, vea The tile template catalog, The toast template catalog y Badge overview.

type

Especifica el tipo de notificación, como uno de los valores de cadena siguientes:

 

Valor Descripción

wns/badge

Notificación para crear una superposición de distintivo en el mosaico. El encabezado Content-Type incluido en la solicitud de notificación se debe establecer en "text/xml".

wns/tile

Notificación para actualizar el contenido del mosaico. El encabezado Content-Type incluido en la solicitud de notificación se debe establecer en "text/xml".

wns/toast

Notificación para generar un notificación en el cliente. El encabezado Content-Type incluido en la solicitud de notificación se debe establecer en "text/xml".

wns/raw

Notificación que puede contener una carga personalizada y se envía directamente a la aplicación. El encabezado Content-Type incluido en la solicitud de notificación se debe establecer en "application/octet-stream".

options

Objeto que se emplea para proporcionar las devoluciones de llamada de operación correcta y con errores, y otros comportamientos opcionales de la notificación:

{
    success: success,
    error: error,
    headers: wns_headers, 
}

Donde success es la función a la que se llama después de enviarse la notificación, error es la función a la que se llama cuando se produce un error y headers es la lista de todos los encabezados de solicitud HTTP adicionales que se van a incluir en la solicitud enviada a WNS.

Para obtener una lista de los encabezados de solicitud HTTP disponibles, vea Push notification service request and response headers.

Devuelve

Sin definir.

El objeto payload tiene las siguientes consideraciones con respecto a la asignación de nombre y al orden de los campos según la plantilla específica:

  • textN especifica el valor de cadena del N-simo campo de texto en el orden del documento, empezando en 1.

  • imageNsrc especifica la dirección URL de la N-sima imagen en el orden del documento, empezando en 1.

  • imageNalt especifica el texto alt de la N-sima imagen en el orden del documento, empezando en 1.

  • Se supone que todos los campos que faltan son cadenas vacías.

  • Se omiten los campos adicionales que una plantilla específica no necesita.

Al llamar al método sendRaw, la carga de notificación se entrega a la aplicación y no se muestra en la interfaz de usuario. Para obtener más información, vea Raw notification overview (Windows Store apps).

En el script siguiente se usa el objeto wns para enviar notificaciones del sistema a una Aplicación de la Tienda Windows.

function insert(comment, user, request) { 
  request.execute({ 
    success: function() { 
      var sql = "SELECT deviceId FROM devices " + 
      "INNER JOIN posts ON devices.userId = posts.userId " + 
      "WHERE posts._id = ?"; 
      mssql.query(sql, [comment.postId], { 
        success: function(results) { 
          if(results.length > 0) { 
            push.wns.sendToastText04(results[0].deviceId, { 
              text1: comment.username + ' commented on your post!' 
            }); 
          } 
        } 
      }); 
      // Write to the response for the original request while the push notification happens in the background 
      request.respond(); 
    } 
  }); 
}

En el script siguiente se llama al método sendRaw del objeto wns para enviar una notificación del sistema con formato previo usando la plantilla ToastImageAndText03.

function insert(item, user, request) {
    request.execute({
        success: function() {
            // Write to the response and then send a raw notification in the background.
            request.respond();
            push.wns.sendRaw(item.channel,'{ notification: raw, text: "Raw notification string" }' + 
            item.text, {
                success: function(pushResponse) {
                    console.log("Sent push:", pushResponse);
                }
            });
        }
    });
}

En el script siguiente se llama al método send del objeto wns para enviar una notificación del sistema con formato previo usando la plantilla ToastImageAndText03.

function insert(item, user, request) {
    request.execute({
        success: function() {
            // Write to the response and then send the pre-formatted notification in the background.
            request.respond();
            push.wns.send(item.channel,'<toast launch=""><visual lang="en-US">' +
            '<binding template="ToastImageAndText03"><image id="1" src="imageUri" />' + 
            '<text id="1">Template: ToastImageAndText03</text>' + 
            '<text id="2">' + item.text + '</text></binding></visual></toast>',
            "wns/toast", {
                success: function(pushResponse) {
                    console.log("Sent push:", pushResponse);
                }
            });
        }
    });
}

Mostrar:
© 2014 Microsoft