Classes
Methods
-
<inner> runStartupScripts(env)
-
Método que executa a inicialização do Framework.
Parameters:
Name Type Description env
Environment Objeto Environment do Framework.
Type Definitions
-
CloseViewRequest
-
Type:
- Object
Properties:
Name Type Description viewId
string Id da visualização que será fechada.
-
CloseViewResponse
-
Type:
- Object
Properties:
Name Type Description viewId
string Id da visualização que foi fechada.
-
DiscardProcessResponse
-
Type:
- Object
Properties:
Name Type Description processId
string Id do processo que deve ser descartado.
-
PingRequest
-
Type:
- Object
Properties:
Name Type Argument Description processId
string <optional>
Id do processo que está sendo executado.
-
RefreshViewRequest
-
Type:
- Object
Properties:
Name Type Description viewId
string Id da visualização que será atualizada.
-
RefreshViewResponse
-
Type:
- Object
Properties:
Name Type Description currentId
string Id atual do processo.
id
string Novo id do processo que foi atualizado.
-
RunActivityRequest
-
Type:
- Object
Properties:
Name Type Argument Description activityName
string Nome da atividade que será executada.
parameters
Array.<any> <optional>
Parâmetros que serão passados para o processo.
processKey
number <optional>
Chave do processo que será executado.
processId
string <optional>
Id do processo que será executado.
icon
string <optional>
Ícone que será exibido na aba do processo.
canDoHistory
boolean <optional>
Indica se o processo pode fazer histórico.
lastShownProcessId
string <optional>
Id do último processo que foi exibido.
validateLastActivity
boolean <optional>
Indica se a última atividade deve ser validada.
-
RunActivityResponse
-
Type:
- Object
Properties:
Name Type Argument Description id
string Id do processo que foi executado.
menuPath
string Caminho do menu do processo.
icon
string <optional>
Ícone que será exibido na aba do processo.
processKey
number <optional>
Chave do processo que foi executado.
priorId
string <optional>
Id do processo que foi executado anteriormente, se houver.
-
SessionTimeoutsInfo
-
Type:
- Object
Properties:
Name Type Description inactivity
number Quantidade de milissegundos que a sessão pode ficar ativa antes do tratamento de sessões inativas ser realizado.
lockedScreen
number Quantidade de milissegundos que a sessão pode ficar com a tela bloqueada antes que a sessão seja encerrada.
-
StartupResponse
-
Type:
- Object
Properties:
Name Type Argument Description exiting
boolean Indica se o ambiente está saindo.
homeProcess
Object <optional>
Informações do processo inicial que será executado.
Properties
Name Type Description key
string Chave do processo inicial.
interactionName
string Nome da interação inicial.
serializedParameters
Array.<any> Parâmetros que serão passados para o processo inicial.
-
SyncCommand
-
Comando de sincronismo enviado para cliente ou para o servidor.
Type:
- Object
Properties:
Name Type Argument Description target
string Alvo do sincronismo a ser executado.
id
string | number <optional>
Identificação do tipo de sincronismo.
data
* <optional>
Dados a do sincronismo, variam de acordo com o tipo de sincronismo.
-
SyncRequest
-
Requisição de sincronismo solicitada pelo cliente.
Type:
- Object
Properties:
Name Type Description sequence
number Sequência da requisição do cliente.
messages
Array.<{targetId: string, message: *}> Mensagens que foram enviadas pelo cliente e que devem ser processadas pelo serviço de mensagens do Web Framework.
timestamp
number Timestamp da requisição do cliente.
lastUse
number Timestamp da última utilização do sistema pelo usuário.
data
Array.<SyncCommand> Comandos de sincronismo que foram enviadas pelo cliente.
-
SyncResponse
-
Resultado da requisição de sincronismo solicitada pelo cliente.
Type:
- Object
Properties:
Name Type Description action
string Tipo de ação de sincronismo.
data
* Dados da ação do sincronismo. O conteúdo varia de acordo com o tipo de ação de sincronismo.
-
TabInfo
-
Informações de uma aba aberta do Web Framework.
Type:
- Object
Properties:
Name Type Description processIds
Array.<string> Ids dos processos que foram visualizados nesta aba.
currentProcessId
string Id do processo atualmente visível na aba.
-
UpdatePasswordRequest
-
Type:
- Object
Properties:
Name Type Description password
string Senha criptografada do usuário que será atualizada.