Package com.fluig.sdk.service

Interface AlertService

  • All Superinterfaces:
    BaseAPIService
    public interface AlertService
extends BaseAPIService
    Fornece acesso aos serviços de notificações.
    Since:
    1.5.8
    Author:
    luis.junior

    • Method Detail

      • getTenantTotalOfNotification

        Long getTenantTotalOfNotification()
                           throws com.fluig.sdk.api.common.SDKException
        Get the number of notification in the tenant
        Throws:
        com.fluig.sdk.api.common.SDKException

      • listAllAlerts

        List<AlertVO> listAllAlerts​(int limit,
                            int offset)
                     throws com.fluig.sdk.api.common.SDKException
        Retorna todas as notificações do usuário logado ordenadas pela data de criação.
        Parameters:
        limit -
        offset -
        Returns:
        lista de notificações.
        Throws:
        com.fluig.sdk.api.common.SDKException

      • listAlertsWithNote

        List<AlertVO> listAlertsWithNote​(int limit,
                                 int offset)
                          throws com.fluig.sdk.api.common.SDKException
        Busca os alertas com nota, do usuário logado ordenado pela data de criação.
        Parameters:
        limit - - limit de resultados
        offset - - offset
        Returns:
        lista de alertas
        Throws:
        com.fluig.sdk.api.common.SDKException

      • listAlertsWithAction

        List<AlertVO> listAlertsWithAction​(int limit,
                                   int offset)
                            throws com.fluig.sdk.api.common.SDKException
        Busca os alertas com ação vinculada, do usuário logado ordenado pela data de criação.
        Parameters:
        limit - - limit de resultados
        offset - - offset
        Returns:
        lista de alertas
        Throws:
        com.fluig.sdk.api.common.SDKException

      • listAllAlertsByModule

        List<AlertVO> listAllAlertsByModule​(String module,
                                    int limit,
                                    int offset)
                             throws com.fluig.sdk.api.common.SDKException
        Retorna todas as notificações de um usuário por um único módulo
        Parameters:
        module -
        limit -
        offset -
        Returns:
        lista de notificações.
        Throws:
        com.fluig.sdk.api.common.SDKException

      • sendNotification

        void sendNotification​(String eventKey,
                      String loginSender,
                      String loginReceiver,
                      com.totvs.technology.foundation.alert.AlertObject object,
                      com.totvs.technology.foundation.alert.AlertObject place,
                      List<com.totvs.technology.foundation.alert.AlertAction> actions,
                      Map<String,​String> metadata)
               throws com.fluig.sdk.api.common.SDKException
        Método que deve ser invocado por todos os módulos do sistema para enviar alertas.
        Parameters:
        eventKey - - String única que representa o evento que gerou o alerta.
        loginSender - - Login(alias) do usuário que está enviando a notificação (tabela FDN_USERTENANT) (opcional)
        loginReceiver - - Login(alias) do usuário que receberá a notificação (tabela FDN_USERTENANT)
        object - - Objeto sobre o qual o evento foi gerado (opcional)
        place - - Lugar onde o evento foi gerado (opcional)
        actions - - Ações disponibilizadas pela notificação
        metadata - - Metadados para serem armazenados no alerta
        Throws:
        com.fluig.sdk.api.common.SDKException - - Indica falha no envio

      • removeAlerts

        void removeAlerts​(String loginSender,
                  List<Long> alertsId)
           throws com.fluig.sdk.api.common.SDKException
        Método que remove os alertas informados de um usuario tambem dado, esse método também é responsável por remover os senders, places e objects relacionado aos alertas
        Parameters:
        loginSender - - Login(alias) do usuário que está enviando a notificação (tabela FDN_USERTENANT)
        alertsId - - Lista de id dos alertas
        Throws:
        com.fluig.sdk.api.common.SDKException - - Indica falha na remoção

      • markAlertAsRead

        void markAlertAsRead​(String loginReceiver,
                     List<Long> alertsId)
              throws com.fluig.sdk.api.common.SDKException
        Método marca os alertas informados de um usuario tambem dado como lidos
        Parameters:
        loginReceiver - - Login(alias) do usuário que recebeu as notificações (tabela FDN_USERTENANT)
        alertsId - - Lista de id dos alertas
        Throws:
        com.totvs.technology.foundation.common.exception.FDNException - - Indica falha na atualização
        com.fluig.sdk.api.common.SDKException

      • markAllAlertsAsRead

        void markAllAlertsAsRead​(String loginReceiver)
                  throws com.fluig.sdk.api.common.SDKException
        Método marca todos os alertas de um usuario como lidos.
        Parameters:
        loginReceiver - - Login(alias) do usuário que recebeu a notificação (tabela FDN_USERTENANT)
        Throws:
        com.totvs.technology.foundation.common.exception.FDNException - - Indica falha na atualização
        com.fluig.sdk.api.common.SDKException

      • countUnreadAlerts

        Long countUnreadAlerts​(Long receiverId)
                throws com.fluig.sdk.api.common.SDKException
        Método que conta os alertas não lidos de um usuário.
        Parameters:
        receiverId - - id do usuário.
        Returns:
        número de alertas não lidos
        Throws:
        com.totvs.technology.foundation.common.exception.FDNException - - Caso ocorra um erro na busca
        com.fluig.sdk.api.common.SDKException

      • countUnreadAlertsByModule

        Long countUnreadAlertsByModule​(String module,
                               Long receiverId)
                        throws com.fluig.sdk.api.common.SDKException
        Método que conta os alertas de um modulo não lidos de um usuário
        Parameters:
        receiverId - - id do usuário.
        Returns:
        número de alertas não lidos
        Throws:
        com.totvs.technology.foundation.common.exception.FDNException - - Caso ocorra um erro na busca
        com.fluig.sdk.api.common.SDKException

      • saveConfiguration

        void saveConfiguration​(AlertConfigVO alertConfig)
                throws com.fluig.sdk.api.common.SDKException
        Salva a configuração de um usuário para receber ou não alertas de um dado evento através de um dado aplicativo.
        Parameters:
        alertConfig - - Configuração do alertas
        Throws:
        com.totvs.technology.foundation.common.exception.FDNException - - Indica falha ao salvar a configuração
        com.fluig.sdk.api.common.SDKException