Esta página foi útil?
Seus comentários sobre este conteúdo são importantes. Queremos saber sua opinião.
Comentários adicionais?
1500 caracteres restantes
Exportar (0) Imprimir
Expandir Tudo

objeto push

Atualizado: junho de 2015

Fornece acesso a objetos que são usados para enviar notificações por push para aplicativos dos Serviços Móveis do back-end do JavaScript. Os Serviços Móveis integram com os Hubs de Notificação do Azure para oferecer suporte à funcionalidade de notificação por push, como modelos, plataformas múltiplas e escala aprimorada. Para obter mais informações, consulte Introdução a notificações por push.

 

Nome Retorna Descrição

apns

objeto apns

Retorna um apns object que é usado para enviar notificações por push para um aplicativo iOS usando os Serviços de Notificação por Push da Apple (APNS).

gcm

objeto gcm

Retorna um gcm object que é usado para enviar notificações por push para um aplicativo do Android usando o Google Cloud Messaging (GCM).

mpns

objeto mpns

Retorna um objeto mpns que é usado para enviar notificações por push para um aplicativo Windows Phone 8 ou Window Phone Silverlight 8.1 usando os Serviços de Notificação por Push da Microsoft (MPNS).

wns

objeto wns

Retorna um objeto wns que é usado para enviar notificações por push para um Aplicativo da Windows Store usando os Serviços de Notificação do Windows (WNS).

createOrUpdateRegistration (registro, opções, retorno de chamada)
Cria ou atualiza um registro.

Parâmetros

Nome Tipo Argumento Descrição

registration

string

O registro a ser atualizado.

options

objeto

<opcional>

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

Propriedades

Nome Tipo Argumento Descrição

etag

objeto

<opcional>

A etag.

callback

objeto

<opcional>

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

createRegistrationId (retorno de chamada)
Cria um identificador de registro.

Parâmetros

Nome Tipo Argumento Descrição

callback

objeto

<opcional>

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

deleteRegistration (registrationId, opções, retorno de chamada)
Exclui um registro.

Parâmetros

Nome Tipo Argumento Descrição

registrationId

string

O registro a ser excluído.

options

objeto

<opcional>

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

Propriedades

Nome Tipo Argumento Descrição

etag

objeto

<opcional>

A etag.

callback

objeto

<opcional>

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

getRegistration (registrationId, opções, retorno de chamada)
Recupera um registro existente com o registrationId especificado.

Parâmetros

Nome Tipo Argumento Descrição

registrationId

string

O registro a recuperar.

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.

callback

objeto

<opcional>

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

listRegistrations (opções, retorno de chamada)
Retorna todos os registros existentes.

Parâmetros

Nome Tipo Argumento Descrição

options

objeto

<opcional>

As opções de solicitação ou a função de retorno de chamada. As propriedades adicionais serã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.

listRegistrationsByTag (marca, opções, retorno de chamada)
Retorna todos os registros existentes com a tag especificada.

Parâmetros

Nome Tipo Argumento Descrição

tag

string

A marca de registro.

options

objeto

<opcional>

As opções de solicitação ou a função de retorno de chamada. As propriedades adicionais serã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, opções, retorno de chamada)
Envia uma mensagem de modelo.

Parâmetros

Nome Tipo Argumento 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 mensagem do modelo.

options

objeto

<opcional>

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

Propriedades

Nome Tipo Argumento Descrição

cabeçalhos

objeto

<opcional>

Cabeçalhos adicionais.

callback

objeto

<opcional>

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

updateRegistration (registro, opções, retorno de chamada)
Atualiza um registro existente.

Parâmetros

Nome Tipo Argumento Descrição

registration

objeto

O registro a ser atualizado.

options

objeto

<opcional>

O registro a ser atualizado. Consulte a seção de comentários para a definição do objeto de registro.

callback

objeto

<opcional>

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

O objeto push global é usado para se registrar para notificações de push com hubs de notificação e enviar mensagens para os registros de modelo. Use os objetos específicos de plataforma push para enviar mensagens para registros nativos. Embora você possa se registrar para notificação por push do seu back-end de Serviços Móveis, recomendamos ter o registro de cliente para notificações chamando métodos de registro no cliente. Para obter mais informações, consulte Adicionar notificação por push ao aplicativo de Serviços Móveis.

Você pode injetar lógica de negócios no processo de registro iniciado pelo cliente. Para obter mais informações, consulte Registration endpoint.

O objeto callback fornecido ao parâmetro callback é definido da seguinte maneira:

Objeto de retorno de chamada

Propriedade Tipo Descrição

success

Função

A função que é chamada quando a operação é bem-sucedida. A resposta de bem-sucedida é passada para a função.

error

Função

A função que é chamada quando a operação falha. A resposta de erro é passada para a função.

Veja a seguir um exemplo do objeto de retorno de chamada:

{ success: function(result){
      // Do something with the success response.
   }, error: function(error){
      // Do something with the error response.
   }
}

O objeto registration é definido da seguinte maneira:

Objeto de registro

Propriedade Tipo Aplica-se a Descrição

registrationId

string

Tudo

ID de registro.

channelUri

string

WNS ou apenas MPNS

Canal URI atual do registro.

deviceToken

string

Somente APNS

Token de dispositivo atual do registro.

gcmRegistrationId

string

Somente GCM

RegistrationId atual do registro.

tags

string

Tudo

Lista separada por vírgulas de marcas (sem espaços).

bodyTemplate

objeto

Somente modelo

Define um corpo de registro de modelo.

wnsHeaders

objeto

Somente WNS

Cabeçalhos adicionais usados com WNS.

mpnsHeaders

objeto

Somente MPNS

Cabeçalhos adicionais usados com MPNS.

expiry

string

Somente APNS

Expiração do registro APNS.

Mostrar:
© 2015 Microsoft