sc_send_notification('title', 'message', 'destiny_type', 'to', 'from', 'link', 'dtexpire', 'profile')

A macro sc_send_notification permite o envio de notificações para os usuários do sistema de forma dinâmica.

 

Descrição dos Parâmetros

Parâmetro Descrição Exemplo
title =>

Parâmetro obrigatório que recebe o título da notificação que será enviada.

O texto pode ser informado entre aspas, utilizando variáveis ou langs.

Utilizando variável
$title_not = "titulo da mensagem";
'title' => $title_not

Texto direto na macro ou com lang
'title' => 'titulo da mensagem' ou 'title' => {lang_titulo_notificacao} 
message =>

Parâmetro obrigatório que recebe o corpo da mensagem de notificação que será enviada.

Este parâmetro permite a utilização de textos com ou sem formatação HTML e pode ser informando entre aspas, variáveis ou lang.

Utilizando variável
$msg_not = "Corpo da mensagem de notificação";
'message' => $msg_not

Texto direto na macro
'message' => 'Corpo da mensagem de notificação'
destiny_type =>

Parâmetro obrigatório que define quais os dados devem ser informados no parâmetro to para a realização do envio da notificação.

Os valores que devem ser informados são:

  • 'user' - Define que parâmetro to deverá receber o login dos usuários que devem receber a mensagem de notificação.
  • 'group' - Define que parâmetro to deverá receber o nome dos grupos, do módulo de segurança, que devem receber a mensagem de notificação. Esta opção está disponível apenas em sistemas que utilizem o módulo de segurança por grupo.
  • 'all' - Define que todos os usuários do sistema devem receber a mensagem de notificação. Neste caso o parâmetro to deve ser passado como vazio
  • 'profile' - Define que o parâmetro to deverá receber o nome dos perfis criados no sistema de notificação, na aplicação Enviar notificação, que devem receber a mensagem.
 Exemplo de como o parâmetro deve ser informado
'destiny_type' => 'user'

Os valores aceitos são: user, group, all e profile
to =>

Define os usuários do sistema que devem receber a notificação, dentro do universo informando no parâmetro destiny_type.

  • Ao informar destiny_type =>'user' - O desenvolvedor deve informar uma lista do login dos usuários que devem receber a notificação. Os valores informados devem ser separados por ponto e virgula (;).
  • Ao informar destiny_type => 'group' - O desenvolvedor deve informar a lista de grupos de usuários, do módulo de segurança, que devem receber a notificação.
  • Ao informar destiny_type => 'all' - Neste caso todos os usuários do sistema devem receber a notificação e o parâmetro to deve receber valor vazio.
  • destiny_type => 'profile' - O deve informar o nome dos perfis criados no sistema de notificação, na aplicação Enviar notificação, que devem receber a mensagem.

Em todos os casos, os valores informados devem ser separados por ponto e virgula (;)

Exemplo ao utilizar destiny_type =>'user'
'to' => 'joao;pedro;carlos'

Exemplo ao utilizar destiny_type =>'group'
'to' => 'funcionarios;administradores'

Exemplo ao utilizar destiny_type =>'all'
'to' => ''

Exemplo ao utilizar destiny_type =>'profile'
'to' => 'nome_grupo_de_envio1;nome_grupo_de_envio2'
from =>

Parâmetro obrigatório que define o usuário do sistema que está enviado a notificação.

Este parâmetro aceita apenas um valor por vez, e pode ser definido informando diretamente o nome de um usuário ou através de variável.

 'from' => 'admin'
link =>

Parâmetro opcional que recebe um link para acessar uma aplicação do sistema ou uma URL externa.

O texto pode ser informado entre aspas, utilizando variáveis.

Informando uma URL externa
'link' => 'https://scriptcase.com.br/'

Informando uma aplicação do sistema
'link' => 'app_name'
dtexpire =>

Parâmetro opcional que define o dia e hora que a notificação irá expirar e deixará de ser exibida no ícone de acesso rápido do menu. Ao atingir a data o usuário poderá acessar a mensagem apenas através da aplicação de inbox.

O formato da data e hora, obrigatoriamente deve ser: YYYY-MM-DD HH:MM:SS

 'dtexpire' => '2024-10-02 23:59:59'
profile =>

Parâmetro obrigatório que deve receber o nome do perfil que o desenvolvedor informou ao criar o módulo de notificação na interface do Scriptcase.

 'profile' => 'samples_notification'

 

Exemplo

$title = 'Novo usuário';
$msg = 'Usuário: ' . $struser . ' registrado no sistema';

sc_send_notification([
    'title' => $title,
    'message' => $msg,
    'destiny_type' => 'user',
    'to' => 'admin',
    'from' => 'admin',
    'link' => '',
    'dtexpire' => '2024-10-02 23:59:59',    
    'profile' => 'samples_profile_name',
]);