¿Le resultó útil esta página?
Sus comentarios sobre este contenido son muy importantes. Háganos saber su opinión.
¿Tiene comentarios adicionales?
Caracteres restantes: 1500
Exportar (0) Imprimir
Expandir todo

wns, objeto

Actualizado: junio de 2015

Permite enviar notificaciones push a una aplicación de la Tienda Windows o una aplicación de Windows universal desde los scripts de servidor de Servicios móviles de Microsoft Azure, usando para ello los Centros de notificaciones de Azure.

createNativeRegistration(channel, tags, optionsOrCallback, callback)
Crea un registro WNS nativo.

Parámetros

Nombre Tipo Argumento Descripción

channel

string

URI de canal del dispositivo.

tags

cadena | matriz

Una sola etiqueta o una matriz de etiquetas (lista separada por comas sin espacios).

options

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

callback

objeto

<opcional>

Objeto JSON que especifica las funciones de devolución de llamada success y error.

createOrUpdateNativeRegistration(registrationId, channel, tags, optionsOrCallback, callback)
Crea o actualiza un registro WNS nativo.

Parámetros

Nombre Tipo Argumento Descripción

registrationId

string

Identificador del registro.

channel

string

URI de canal del dispositivo.

tags

cadena | matriz

Una sola etiqueta o una matriz de etiquetas (lista separada por comas sin espacios).

options

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

callback

objeto

<opcional>

Objeto JSON que especifica las funciones de devolución de llamada success y error.

createOrUpdateRawTemplateRegistration(registrationId, channel, tags, template, optionsOrCallback, callback)
Crea o actualiza un registro de plantilla personalizado. Emplee este método para tener pleno control en el formato de la plantilla. También debe especificar el encabezado X-WNS-Type (los valores posibles son: wns/toast, wns/tile, wns/badge, wns/raw).

Parámetros

Nombre Tipo Argumento Descripción

registrationId

string

Identificador del registro.

channel

string

URI de canal del dispositivo.

tags

cadena | matriz

Una sola etiqueta o una matriz de etiquetas (lista separada por comas sin espacios).

template

string

Plantilla XML del registro.

options

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

Propiedades

Nombre Tipo Argumento Descripción

pnsCredentialName

objeto

<opcional>

Credenciales de PNS que se van a usar.

headers

objeto

<opcional>

Encabezados de wns que se van a incluir.

callback

objeto

<opcional>

Objeto JSON que especifica las funciones de devolución de llamada success y error.

createRawTemplateRegistration(channel, tags, template, optionsOrCallback, callback)
Crea un registro de plantilla personalizado. Emplee este método para tener pleno control en el formato de la plantilla. También debe especificar el encabezado X-WNS-Type (los valores posibles son: wns/toast, wns/tile, wns/badge, wns/raw).

Parámetros

Nombre Tipo Argumento Descripción

channel

string

URI de canal del dispositivo.

tags

cadena | matriz

Una sola etiqueta o una matriz de etiquetas (lista separada por comas sin espacios).

template

string

Plantilla XML del registro.

options

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

Propiedades

Nombre Tipo Argumento Descripción

pnsCredentialName

objeto

<opcional>

Credenciales de PNS que se van a usar.

headers

objeto

<opcional>

Encabezados de wns que se van a incluir.

callback

objeto

<opcional>

Objeto JSON que especifica las funciones de devolución de llamada success y error.

createTile*Registration(channel, tags, template, options, callback)
Crea un nuevo registro con una plantilla de mosaico. Hay un método para cada plantilla de mosaico en el catálogo de plantillas de mosaico, como createTileSquarePeekImageAndText01Registration.

Parámetros

Nombre Tipo Argumento Descripción

channel

string

URI de canal del dispositivo.

tags

cadena | matriz

Una sola etiqueta o una matriz de etiquetas (lista separada por comas sin espacios).

template

objeto

Plantilla de cuerpo del registro.

Propiedades

Nombre Tipo Descripción

text{1..n}

string

Valor del elemento de texto con el identificador especificado, como text1. El número de propiedades text* depende del tipo de mosaico.

image{1..n}src

string

Valor del atributo src del elemento de imagen con el identificador especificado, como image1. El número de propiedades image* depende del tipo de mosaico.

image{1..n}alt

string

Valor del atributo alt del elemento de imagen con el identificador especificado, como image1. El número de propiedades image* depende del tipo de mosaico.

lang

string

Valor del lenguaje del elemento de enlace.

options

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

Propiedades

Nombre Tipo Argumento Descripción

headers

objeto

<opcional>

Encabezados de wns que se van a incluir.

callback

objeto

<opcional>

Objeto JSON que especifica las funciones de devolución de llamada success y error.

createToast*Registration(channel, tags, template, options, callback)
Crea un registro con una plantilla de notificación. Hay un método para cada plantilla de notificación del sistema en el catálogo de plantillas de notificación del sistema, como createToastText01Registration.

Parámetros

Nombre Tipo Argumento Descripción

channel

string

URI de canal del dispositivo.

tags

cadena | matriz

Una sola etiqueta o una matriz de etiquetas (lista separada por comas sin espacios).

template

objeto

Plantilla de cuerpo del registro.

Propiedades

Nombre Tipo Descripción

text{1..n}

string

Valor del elemento de texto con el identificador especificado, como text1. El número de propiedades text* depende del tipo de notificación del sistema.

image{1..n}src

string

Valor del atributo src del elemento de imagen con el identificador especificado, como image1. El número de propiedades image* depende del tipo de notificación del sistema.

image{1..n}alt

string

Valor del atributo alt del elemento de imagen con el identificador especificado, como image1. El número de propiedades image* depende del tipo de notificación del sistema.

lang

string

Valor del lenguaje del elemento de enlace.

options

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

Propiedades

Nombre Tipo Argumento Descripción

headers

objeto

<opcional>

Encabezados de wns que se van a incluir.

callback

objeto

<opcional>

Objeto JSON que especifica las funciones de devolución de llamada success y error.

listRegistrationsByChannel(channel, optionsOrCallback, callback)
Recupera registros según el URI de canal.

Parámetros

Nombre Tipo Argumento Descripción

channel

string

URI de canal del dispositivo.

options

objeto

<opcional>

Opciones de solicitud o función de devolución de llamada. Las propiedades adicionales se pasan como encabezados.

Propiedades

Nombre Tipo Argumento Descripción

top

objeto

<opcional>

Especifica el número máximo de registros que se obtiene de la llamada.

skip

objeto

<opcional>

Especifica el número de registros que se va a omitir en la llamada.

callback

objeto

<opcional>

Objeto JSON que especifica las funciones de devolución de llamada success y error.

send(tags, payload, type, optionsOrCallback, callback)
Envía una notificación WNS personalizada. Emplee este método si quiere tener pleno control de la carga.

Parámetros

Nombre Tipo Argumento Descripción

tags

matriz | cadena

Una etiqueta única, expresión de etiqueta o matriz de etiquetas.

payload

string

Carga XML del mensaje.

type

string

El tipo de mensaje. Corresponde al encabezado X-WNS-Type (las opciones son: wns/raw, wns/tile y wns/toast).

optionsOrCallback

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

Propiedades

Nombre Tipo Argumento Descripción

headers

objeto

<opcional>

Encabezados de wns que se van a incluir.

callback

objeto

Objeto JSON que especifica las funciones de devolución de llamada success y error.

sendBadge(tags, value, optionsOrCallback, callback)
Envía una notificación WNS de wns/badge.

Parámetros

Nombre Tipo Argumento Descripción

tags

matriz | cadena

Lista separada por comas o matriz de identificadores de etiqueta.

value

objeto | cadena

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. Para obtener más información, consulte el tema sobre elemento Badge.

optionsOrCallback

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

Propiedades

Nombre Tipo Argumento Descripción

headers

objeto

<opcional>

Encabezados de wns que se van a incluir.

callback

objeto

Objeto JSON que especifica las funciones de devolución de llamada success y error.

sendRaw(tags, payload, optionsOrCallback, callback)
Envía una notificación WNS de wns/raw.

Parámetros

Nombre Tipo Argumento Descripción

tags

matriz | cadena

Lista separada por comas o matriz de identificadores de etiqueta.

payload

objeto | cadena

La carga sin procesar.

optionsOrCallback

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

Propiedades

Nombre Tipo Argumento Descripción

headers

objeto

<opcional>

Encabezados de wns que se van a incluir.

callback

objeto

Objeto JSON que especifica las funciones de devolución de llamada success y error.

sendTile*(tags, payload, options, callback)
Envía una notificación de mosaico. Hay un método para cada plantilla de mosaico en el catálogo de plantillas de mosaico, como sendTileSquarePeekImageAndText01.

Parámetros

Nombre Tipo Argumento Descripción

tags

cadena | matriz

Una etiqueta única o expresión de etiqueta.

payload

objeto

Carga del mensaje. Se pueden pasar varios parámetros de carga.

Propiedades

Nombre Tipo Descripción

text{1..n}

string

Valor del elemento de texto con el identificador especificado, como text1. El número de propiedades text* depende del tipo de mosaico.

image{1..n}src

string

Valor del atributo src del elemento de imagen con el identificador especificado, como image1. El número de propiedades image* depende del tipo de mosaico.

image{1..n}alt

string

Valor del atributo alt del elemento de imagen con el identificador especificado, como image1. El número de propiedades image* depende del tipo de mosaico.

lang

string

Valor del lenguaje del elemento de enlace.

tipo

string

Utilizado en el método sendTile general.

options

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

Propiedades

Nombre Tipo Argumento Descripción

headers

objeto

<opcional>

Encabezados de wns que se van a incluir.

callback

objeto

<opcional>

Objeto JSON que especifica las funciones de devolución de llamada success y error.

sendToast*(tags, payload, options, callback)
Envía una notificación del sistema. Hay un método para cada plantilla de notificación del sistema en el catálogo de plantillas de notificación del sistema, como sendToastText01.

Parámetros

Nombre Tipo Argumento Descripción

tags

cadena | matriz

Una etiqueta única o expresión de etiqueta.

payload

objeto

Carga del mensaje.

Propiedades

Nombre Tipo Descripción

text{1..n}

string

Valor del elemento de texto con el identificador especificado, como text1. El número de propiedades text* depende del tipo de notificación del sistema.

image{1..n}src

string

Valor del atributo src del elemento de imagen con el identificador especificado, como image1. El número de propiedades image* depende del tipo de notificación del sistema.

image{1..n}alt

string

Valor del atributo alt del elemento de imagen con el identificador especificado, como image1. El número de propiedades image* depende del tipo de notificación del sistema.

lang

string

Valor del lenguaje del elemento de enlace.

options

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

Propiedades

Nombre Tipo Argumento Descripción

headers

objeto

<opcional>

Encabezados de wns que se van a incluir.

callback

objeto

<opcional>

Objeto JSON que especifica las funciones de devolución de llamada success y error.

updatesRawTemplateRegistration(registrationId, channel, tags, template, optionsOrCallback, callback)
Actualiza un registro de plantilla sin procesar existente.

Parámetros

Nombre Tipo Argumento Descripción

registrationId

string

Identificador del registro.

channel

string

URI de canal del dispositivo.

tags

cadena | matriz

Etiquetas del registro.

template

cadena | matriz

Plantilla sin procesar del registro.

options

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

Propiedades

Nombre Tipo Argumento Descripción

pnsCredentialName

objeto

<opcional>

Credenciales de PNS que se van a usar.

headers

objeto

<opcional>

Encabezados de wns que se van a incluir.

etag

objeto

<opcional>

Etag que se va a incluir.

callback

objeto

Objeto JSON que especifica las funciones de devolución de llamada success y error.

updateTile*Registration(registrationId, channel, tags, template, options, callback)
Actualiza un registro de plantilla existente con una nueva plantilla de mosaico. Hay un método para cada plantilla de mosaico en el catálogo de plantillas de mosaico, como updadteTileSquarePeekImageAndText01Registration.

Parámetros

Nombre Tipo Argumento Descripción

registrationId

string

Identificador del registro.

channel

string

URI de canal del dispositivo.

tags

cadena | matriz

Etiquetas del registro.

template

objeto

Plantilla de cuerpo del registro.

Propiedades

Nombre Tipo Descripción

text{1..n}

string

Valor del elemento de texto con el identificador especificado, como text1. El número de propiedades text* depende del tipo de mosaico.

image{1..n}src

string

Valor del atributo src del elemento de imagen con el identificador especificado, como image1. El número de propiedades image* depende del tipo de mosaico.

image{1..n}alt

string

Valor del atributo alt del elemento de imagen con el identificador especificado, como image1. El número de propiedades image* depende del tipo de mosaico.

lang

string

Valor del lenguaje del elemento de enlace.

options

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

Propiedades

Nombre Tipo Argumento Descripción

headers

objeto

<opcional>

Encabezados de wns que se van a incluir.

callback

objeto

Objeto JSON que especifica las funciones de devolución de llamada success y error.

updateToast*Registration(registrationId, channel, tags, template, options, callback)
Actualiza un registro de plantilla existente con una nueva plantilla de notificación. Hay un método para cada plantilla de notificación del sistema en el catálogo de plantillas de notificación del sistema, como updateToastText01Registration.

Parámetros

Nombre Tipo Argumento Descripción

registrationId

string

Identificador del registro.

channel

string

URI de canal del dispositivo.

tags

cadena | matriz

Etiquetas del registro.

template

objeto

Plantilla de cuerpo del registro.

Propiedades

Nombre Tipo Descripción

text{1..n}

string

Valor del elemento de texto con el identificador especificado, como text1. El número de propiedades text* depende del tipo de notificación del sistema.

image{1..n}src

string

Valor del atributo src del elemento de imagen con el identificador especificado, como image1. El número de propiedades image* depende del tipo de notificación del sistema.

image{1..n}alt

string

Valor del atributo alt del elemento de imagen con el identificador especificado, como image1. El número de propiedades image* depende del tipo de notificación del sistema.

lang

string

Valor del lenguaje del elemento de enlace.

options

objeto

<opcional>

Opciones de solicitud o devolución de llamada.

Propiedades

Nombre Tipo Argumento Descripción

headers

objeto

<opcional>

Encabezados de wns que se van a incluir.

callback

objeto

Objeto JSON que especifica las funciones de devolución de llamada success y error.

Para obtener un ejemplo de cómo enviar notificaciones push desde su servicio móvil a una aplicación de Windows, vea Incorporación de notificaciones de inserción a la aplicación de Servicios móviles (C# para Tienda Windows/JavaScript para Tienda Windows/C# para Windows universal/JavaScript para Windows universal).

Todos los métodos devuelven undefined.

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).

El script siguiente utiliza la función send en el objeto wns para enviar una notificación a un aplicación de la Tienda Windows.

function insert(item, user, request) {
// Define a payload for the Windows Store toast notification.
var payload = '<?xml version="1.0" encoding="utf-8"?><toast><visual>' +    
    '<binding template="ToastText01">  <text id="1">' +
    item.text + '</text></binding></visual></toast>';

request.execute({
    success: function() {
        // If the insert succeeds, send a notification.
        push.wns.send(null, payload, 'wns/toast', {
            success: function(pushResponse) {
                console.log("Sent push:", pushResponse);
                request.respond();
                },              
                error: function (pushResponse) {
                    console.log("Error Sending push:", pushResponse);
                    request.respond(500, { error: pushResponse });
                    }
                });
            }
        });
}

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(null,'{ notification: raw, text: "Raw notification string" }' + 
            item.text, {
                success: function(pushResponse) {
                    console.log("Sent push:", pushResponse);
                }
            });
        }
    });
}

Mostrar:
© 2015 Microsoft