T2 - Como usar as Notifications?

ADS.FAQ-12818

As notifications permitem notificar eventos para os usu�rios de forma ass�ncrona. Para isso, � necess�rio:

Criar um objeto Notification
Registrar este objeto no gerenciador de notifica��es
Manipular as propriedades deste objeto (�cone, mensagens, etc.)
Remover o objeto do gerenciador de notifica��es

Para entender as notifications, vamos usar um exemplo:
Crie um regra de pos-update de uma entidade qualquer e inclua a implementa��o abaixo:

       Runnable r = new Runnable() {
           @Override
           public void run() {
               // Criar uma mensagem de notifica��o
               Notification n = new Notification()
                       .title("Mudan�a nos clientes")
                       .icon("replicator-working")
                       .cycle(1);
               // Registrar esta mensagem no ambiente
               NotificationManager mgr = NotificationManager.getInstance();
               mgr.add(n);
               // Ficar alterando as propriedades da mensagem
               for (int i = 0; i < 10; i++) {
                   n.setQuantity(i);
                   n.setTitle("A contagem est� em " + i);
                   n.setContent("Esse � um texto que aparece quando o<br>usu�rio clica - "
                           + System.currentTimeMillis());
                   try {
                       Thread.sleep(2000);
                   } catch (InterruptedException ignore) { }
               }
               // Remover a mensagem
               mgr.remove(n);
           }
       };
       Thread t = new Thread(r);
       t.start();

Para testar:

Abra a tela de cadastramento da entidade em quest�o
Altere os dados do registro
Verifique o surgimento de um �cone na parte inferior do sistema - este �cone ir� alterando a contagem de 1 a 9 a cada 2 segundos e depois desaparecer
Posiciona o mouse sobre o �cone - Ir� aparecer um hint com o texto "A contagem est� em X"
Clique sobre o �cone - ir� aparecer um bal�o com um conte�do HTML.

Caso se deseje direcionar a notifica��o apenas para o usu�rio da sess�o corrente, basta incluir o ID da sess�o no Notification:

               Notification n = new Notification()
                       .title("Mudan�a nos clientes")
                       .icon("replicator-working")
                       .session(ctx.getSession().getId())     // Apenas janelas da mesma sess�o ser�o notificadas
                       .cycle(1);

Caso n�o informado, cada notification criado recebe um ID de identifica��o automaticamente. Quando for necess�rio que m�ltiplas rotinas acessem o mesmo objeto de notifica��o, pode-se definir um ID fixo para ele e pega-lo do pr�prio gerenciador (e criando apenas quando n�o for encontrado):

   NotificationManager mgr = NotificationManager.getInstance();
   Notification n = mgr.getNotification("rotina-de-integracao");
   if (n == null) {
       n = new Notification()
               .title("Mudan�a nos clientes")
               .icon("replicator-working")
               .session(ctx.getSession().getId())
               .urgent(true)
               .cycle(1);
       mgr.add(n);
   }

Observa��es:

Quando o usu�rio est� em um atela qualquer, a frequ�ncia de atualiza��o das notifica��es ir� depender da maior frequ�ncia das notifica��es atualmente ativas. Caso nenhuma estiver ativa, o tempo de atualiza��o � de 60 segundos ou o valor configurado na preferencia RT.UI.NOTIFICATIONS_INTERVAL;