Referência da API do plugin Cordova

exemplo

var pushwoosh = cordova.require("pushwoosh-cordova-plugin.PushNotification");

// Deve ser chamado antes de pushwoosh.onDeviceReady
document.addEventListener('push-notification', function(event) {
  var notification = event.notification;
  // manipule a abertura do push aqui
});

// Inicializa o Pushwoosh. Isso acionará todas as notificações push pendentes na inicialização.
pushwoosh.onDeviceReady({
  appid: "XXXXX-XXXXX",
  projectid: "XXXXXXXXXXXXXXX",
  serviceName: "XXXX"
});

pushwoosh.registerDevice(
  function(status) {
    var pushToken = status.pushToken;
      // manipule o registro bem-sucedido aqui
  },
  function(status) {
    // manipule o erro de registro aqui
  }
);

onDeviceReady

PushNotification.prototype.onDeviceReady = function( config )

[android, ios, wp8, windows]
Inicializa o plugin Pushwoosh e aciona uma mensagem push de início. Deve ser chamado a cada inicialização do aplicativo.

config.appid – Código da aplicação Pushwoosh.

config.projectid – Número do projeto GCM para a plataforma Android.

config.serviceName – Nome do serviço MPNS para a plataforma wp8.

exemplo

// inicializa o Pushwoosh com projectid: "GOOGLE_PROJECT_NUMBER", appid : "PUSHWOOSH_APP_ID", serviceName : "WINDOWS_PHONE_SERVICE". Isso acionará todas as notificações push pendentes na inicialização.
pushwoosh.onDeviceReady({
    appid : "XXXXX-XXXXX",
    projectid: "XXXXXXXXXXXXXXX",
    serviceName: "XXXX"
});

registerDevice

PushNotification.prototype.registerDevice = function( success, fail )

[android, ios, wp8, windows]
Registra o dispositivo para notificações push e recupera um Push Token.

success – callback de sucesso. O push token é passado como o parâmetro “status.pushToken” para este callback

fail – callback de erro

exemplo

pushwoosh.registerDevice(
    function(status) {
        alert("Registrado com push token: " + status.pushToken);
    },
    function(error) {
        alert("Falha ao registrar: " +  error);
    }
);

unregisterDevice

PushNotification.prototype.unregisterDevice = function(  success, fail  )

[android, ios, wp8, windows]
Cancela o registro do dispositivo para o recebimento de notificações push.

success – callback de sucesso

fail – callback de erro

setTags

PushNotification.prototype.setTags = function(  config, success, fail  )

[android, ios, wp8, windows]
Define tags para o dispositivo.

Parâmetros

config – objeto com tags personalizadas do dispositivo

success – callback de sucesso. O push token é passado como o parâmetro “status.pushToken” para este callback

fail – callback de erro

exemplo

// define as tags: “deviceName” com o valor “hello” e “deviceId” com o valor 10
pushwoosh.setTags({deviceName:"hello", deviceId:10},
    function() {
        console.warn('setTags success');
    },
    function(error) {
        console.warn('setTags failed');
    }
);

// define a lista de tags "MyTag" com os valores (array) "hello", "world"
pushwoosh.setTags({"MyTag":["hello", "world"]});

getTags

PushNotification.prototype.getTags = function(  success, fail  )

[android, ios, wp8, windows]
Retorna as tags do dispositivo, incluindo as tags padrão.

success – callback de sucesso. Recebe as tags como parâmetros

fail – callback de erro

pushwoosh.getTags(
    function(tags) {
        console.warn('tags for the device: ' + JSON.stringify(tags));
    },
    function(error) {
        console.warn('get tags error: ' + JSON.stringify(error));
    }
);

getPushToken

PushNotification.prototype.getPushToken = function(  success  )

[android, ios, wp8, windows]
Retorna o push token se estiver disponível. Note que o token também vem no callback da função registerDevice.

success – callback de sucesso.

pushwoosh.getPushToken(
    function(token) {
        console.warn('push token: ' + token);
    }
);

getPushwooshHWID

PushNotification.prototype.getPushwooshHWID = function(  success  )

[android, ios, wp8, windows]
Retorna o HWID do Pushwoosh usado para comunicações com a API do Pushwoosh.

success – callback de getPushwooshHWID

pushwoosh.getPushwooshHWID(
    function(token) {
        console.warn('Pushwoosh HWID: ' + token);
    }
);

getRemoteNotificationStatus

PushNotification.prototype.getRemoteNotificationStatus = function(  callback, error  )

[android, ios]
Retorna o status detalhado das permissões de notificação push.

callback – callback de sucesso. Recebe um objeto com as seguintes propriedades:

{
  "enabled" : flag de notificações ativadas.
  "pushBadge" : permissão de badges concedida. (somente iOS)
  "pushAlert" : permissão de alerta concedida. (somente iOS)
  "pushSound" : permissão de som concedida. (somente iOS)
}

error — callback de erro

setApplicationIconBadgeNumber

PushNotification.prototype.setApplicationIconBadgeNumber = function(  badgeNumber  )

[android, ios]
Define o número do badge no ícone da aplicação.

badgeNumber – número do badge do ícone

getApplicationIconBadgeNumber

PushNotification.prototype.getApplicationIconBadgeNumber = function(  callback  )

[android, ios]
Retorna o número do badge no ícone da aplicação.

callback – callback de sucesso

pushwoosh.getApplicationIconBadgeNumber(function(badge){ alert(badge);} );

addToApplicationIconBadgeNumber

PushNotification.prototype.addToApplicationIconBadgeNumber = function( badgeNumber )

[android, ios]
Adiciona um valor ao badge do ícone da aplicação.

badgeNumber — número incremental do badge do ícone

getLaunchNotification

PushNotification.prototype.getLaunchNotification = function(  callback  )

[android, ios]
Retorna o payload da notificação push se o aplicativo foi iniciado em resposta a uma notificação push, ou nulo.

callback – callback de sucesso

clearLaunchNotification

PushNotification.prototype.clearLaunchNotification = function(  callback  )

[android, ios]
Limpa a notificação de inicialização, getLaunchNotification() retornará nulo após esta chamada.

setUserId

PushNotification.prototype.setUserId = function(  userId  )

[android, ios]
Define o identificador do usuário – um ID do Facebook, nome de usuário, e-mail ou qualquer outro ID de usuário. Isso permite que dados e eventos sejam correspondidos em vários dispositivos do usuário.

userId – identificador de string do usuário

postEvent

PushNotification.prototype.postEvent = function( event, attributes )

[android, ios]
Publica eventos para Mensagens In-App. Isso pode acionar a exibição de mensagens In-App conforme especificado no Painel de Controle do Pushwoosh.

event – evento a ser acionado

attributes – objeto com atributos de evento adicionais

pushwoosh.setUserId("XXXXXX");
pushwoosh.postEvent("buttonPressed", { "buttonNumber" : 4, "buttonLabel" : "banner" });

createLocalNotification

PushNotification.prototype.createLocalNotification = function( config, success, fail )

[android, ios]
Agenda uma notificação local.

config.msg – mensagem da notificação

config.seconds – atraso da notificação em segundos

config.userData – dados adicionais para passar na notificação

success – callback de sucesso

fail – callback de erro

pushwoosh.createLocalNotification({msg:"Your pumpkins are ready!", seconds:30, userData:{}})

clearLocalNotification

PushNotification.prototype.clearLocalNotification = function()

[android]
Limpa todas as notificações locais pendentes criadas por createLocalNotification

clearNotificationCenter

PushNotification.prototype.clearNotificationCenter = function()

[android]
Limpa todas as notificações apresentadas na Central de Notificações do Android.

setMultiNotificationMode

PushNotification.prototype.setMultiNotificationMode = function( success, fail )

[android]
Permite que várias notificações sejam exibidas na Central de Notificações do Android.

setSingleNotificationMode

PushNotification.prototype.setSingleNotificationMode = function(  success,
fail  )

[android]
Permite que apenas a última notificação seja exibida na Central de Notificações do Android.

setSoundType

PushNotification.prototype.setSoundType = function( type, success, fail )

[android]
Define o som padrão para pushes recebidos.

type – Tipo de som (0 – padrão, 1 – sem som, 2 – sempre)

setVibrateType

PushNotification.prototype.setVibrateType = function(type, success, fail )

[android]
Define o modo de vibração padrão para pushes recebidos.

type – Tipo de vibração (0 – padrão, 1 – sem vibração, 2 – sempre)

setLightScreenOnNotification

PushNotification.prototype.setLightScreenOnNotification = function( on, success, fail )

[android]
Liga a tela quando uma notificação chega.

on – ativa/desativa o desbloqueio da tela (desativado por padrão)

setEnableLED

PushNotification.prototype.setEnableLED = function( on, success, fail )

[android]
Ativa o piscar do LED quando uma notificação chega e a tela está desligada.

on – ativa/desativa o piscar do LED (desativado por padrão)

setColorLED

PushNotification.prototype.setColorLED = function( color, success, fail )

[android]
Define a cor do LED. Use com setEnableLED.

color – Cor do LED no formato inteiro ARGB

getPushHistory

PushNotification.prototype.getPushHistory = function(  success  )

[android]
Retorna um array de notificações push recebidas.

success – callback de sucesso

pushwoosh.getPushHistory(function(pushHistory) {
    if(pushHistory.length == 0)
        alert("no push history");
    else
        alert(JSON.stringify(pushHistory));
});

pushwoosh.clearPushHistory();

clearPushHistory

PushNotification.prototype.clearPushHistory = function()

[android]
Limpa o histórico de pushes.

cancelAllLocalNotifications

PushNotification.prototype.cancelAllLocalNotifications = function( callback )

[ios]
Limpa todas as notificações locais da central de notificações.

presentInboxUI

[android, ios]
Abre a tela da Caixa de Entrada.

PushNotification.prototype.presentInboxUI = function()

setCommunicationEnabled

Um método binário que ativa/desativa toda a comunicação com o Pushwoosh. O valor booleano false cancela a inscrição do dispositivo para o recebimento de notificações push e interrompe o download de mensagens in-app. O valor true reverte o efeito.

PushNotification.prototype.setCommunicationEnabled = function(enable, success, fail)

removeAllDeviceData

Remove todos os dados sobre o dispositivo.

PushNotification.prototype.removeAllDeviceData = function()

push-receive

[android, ios]
Evento de recebimento de notificação push. É disparado quando o aplicativo recebe uma notificação push em primeiro ou segundo plano. Aplicativos fechados não recebem este evento.

Propriedades do evento

message – (string) Mensagem da notificação push

userdata – (object/array) Dados personalizados da notificação push

onStart – (boolean) É uma notificação de inicialização

foreground – (boolean) A notificação foi recebida em primeiro plano

android – (object) Payload de notificação específico do Android

ios – (object) Payload de notificação específico do iOS

windows – (object) Payload de notificação específico do Windows

document.addEventListener('push-receive',
  function(event) {
    var userData = event.notification.userdata;

    if (typeof(userData) != "undefined") {
      // manipule os dados de notificação personalizados
      console.warn('user data: ' + JSON.stringify(userData));
    }
  }
);

Notificações em primeiro plano

Por padrão, o plugin Pushwoosh não exibe notificações em primeiro plano e aciona automaticamente o evento push-receive. Consulte o guia de personalização do plugin para controlar este comportamento.

push-notification

[android, ios, wp8, windows]
Evento de aceitação de notificação push. É disparado quando o usuário toca na notificação push.

document.addEventListener('push-notification',
  function(event) {
    var message = event.notification.message;
    var userData = event.notification.userdata;

    if (typeof(userData) != "undefined") {
      console.warn('user data: ' + JSON.stringify(userData));
    }
  }
);

Propriedades do evento

O mesmo que push-receive

additionalAuthorizationOptions

[somente ios]
Fornece opções de autorização de notificação _a_dicionais. Deve ser chamado antes de chamar registerDevice.

pushwoosh.additionalAuthorizationOptions({
  "UNAuthorizationOptionCriticalAlert" : 1,
  "UNAuthorizationOptionProvisional": 0 // defina 0 ou não especifique a opção se não quiser adicioná-la ao seu aplicativo.
});