# snk-application ## Properties | Property | Attribute | Description | Type | Default | | ----------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------- | | `configName` | `config-name` | Nome da configuração utilizada para salvar as preferências dos blocos de construção. | `string` | `undefined` | | `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean` | `undefined` | | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário, utilizada para migração de configurações antigas. | `string` | `undefined` | | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade, utilizada para migração de configurações antigas. | `string` | `undefined` | | `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: any; }, redirectFrom?: string) => void` | `undefined` | | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` | ## Events | Event | Description | Type | | -------------------- | ----------------------------------------- | ---------------------- | | `applicationLoaded` | Emitido quando a aplicação for carregada. | `CustomEvent` | | `applicationLoading` | Emitido ao iniciar a carga do componente. | `CustomEvent` | ## Methods ### `addClientEvent(eventID: String, handler: (clientEvent: IClientEventResponse, dataFetcherReacaller: IDataFetcherRecaller) => void) => Promise` Registra um client event para o DataFetcher da aplicação. #### Returns Type: `Promise` --- ### `addLoadingLock(forceReady?: boolean, templateSkeletonType?: TEMPLATES_SKELETON) => Promise<() => void>` Adiciona um bloqueio de carregamento à aplicação. #### Returns Type: `Promise<() => void>` O ID do bloqueio adicionado. --- ### `addPendingAction(actionsLocker: string, action: Function) => Promise` Adiciona uma ação pendente que deve ser executada por um determinado locker. #### Returns Type: `Promise` --- ### `addSearchListener(entityName: string, dataUnit: DataUnit, listener: ISearchListener) => Promise` Adiciona um listener no fetcher de Pesquisa. #### Returns Type: `Promise` Uma função para remover o listener. --- ### `alert(title: string, message: string, icon?: string, options?: MessageOptions) => Promise` Exibe o diálogo de alerta de acordo com os parâmetros passados. #### Returns Type: `Promise` --- ### `callServiceBroker(serviceName: string, payload: string | Object, options?: Options) => Promise` Realiza a chamada ao Service Broker conforme o nome do serviço. #### Returns Type: `Promise` A resposta do Service Broker. --- ### `clearPopUpTitle() => Promise` #### Returns Type: `Promise` --- ### `closeModal() => Promise` Fecha o Modal e limpa o conteúdo. #### Returns Type: `Promise` --- ### `closePopUp() => Promise` Fecha o Popup e limpa o conteúdo. #### Returns Type: `Promise` --- ### `confirm(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions) => Promise` Exibe um diálogo de confirmação. #### Returns Type: `Promise` `true` se confirmado, `false` caso contrário. --- ### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise` Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado. #### Returns Type: `Promise` O DataUnit criado ou obtido do cache. --- ### `error(title: string, message: string, icon?: string, options?: MessageOptions) => Promise` Exibe o diálogo de erro de acordo com os parâmetros passados. #### Returns Type: `Promise` --- ### `executePreparedSearch(mode: string, argument: string, options: any) => Promise | IOption>` Obtém as opções em componentes de pesquisa com base em opções preparadas. Ex.: snk-config-options #### Returns Type: `Promise` Uma lista de opções ou uma única opção. --- ### `executePreparedSearchPlus(mode: string, argument: string, options: any) => Promise | IOption>` Realiza a pesquisa de registros Ex.: snk-config-options #### Returns Type: `Promise` Uma lista de opções ou uma única opção. --- ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise | IOption>` Obtém as opções em componentes de pesquisa. Ex.: snk-config-options #### Returns Type: `Promise` Uma lista de opções ou uma única opção. --- ### `executeSelectDistinct(dataUnit: DataUnit, fieldName: string, argument: string) => Promise>` Com base em um campo realiza um "select distinct" respeitando os filtros atuais do dataUnit e um critério de filtro para a própria coluna. #### Returns Type: `Promise` Uma lista de valores distintos. --- ### `getAllAccess(resourceID?: string) => Promise` Obtém todos os acessos do usuário logado para um recurso específico ou para a aplicação. #### Returns Type: `Promise` Um objeto contendo todos os tipos de acesso e se o usuário os possui. --- ### `getAppLabel() => Promise` Obtém o nome (label) da aplicação. #### Returns Type: `Promise` O nome da aplicação. --- ### `getApplicationPath() => Promise` Retorna o path relativo da aplicação. #### Returns Type: `Promise` O caminho relativo da aplicação. --- ### `getAttributeFromHTMLWrapper(attribName: string) => Promise` Acessa informações de contexto "empurrados" na abertura da tela. #### Returns Type: `Promise` O valor do atributo. --- ### `getBooleanParam(name: string) => Promise` Obtém o valor de um parâmetro do tipo booleano. #### Returns Type: `Promise` O valor do parâmetro como booleano. --- ### `getConfig(key: string) => Promise` Obtém a configuração de um recurso por service broker. #### Returns Type: `Promise` Os dados da configuração. --- ### `getDataFetcher() => Promise` Retorna a instância do DataFetcher utilizado pelo application. #### Returns Type: `Promise` O DataFetcher da aplicação. --- ### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise` Obtém um DataUnit do cache ou cria um caso ainda não tenha sido criado. #### Returns Type: `Promise` O DataUnit obtido do cache ou recém-criado. --- ### `getDateParam(name: string) => Promise` Obtém o valor de um parâmetro do tipo data. #### Returns Type: `Promise` O valor do parâmetro como objeto Date. --- ### `getFloatParam(name: string) => Promise` Obtém o valor de um parâmetro do tipo Decimal. #### Returns Type: `Promise` O valor do parâmetro como número decimal. --- ### `getIntParam(name: string) => Promise` Obtém o valor de um parâmetro do tipo Inteiro. #### Returns Type: `Promise` O valor do parâmetro como número inteiro. --- ### `getKeyboardManager() => Promise` Obtém o controlador de teclado. #### Returns Type: `Promise` O gerenciador de teclado. --- ### `getLayoutFormConfig() => Promise` Obtém o notificador de Layout de formulário. #### Returns Type: `Promise` O configurador de Layout do Formulário. --- ### `getResourceID() => Promise` Obtém o resourceID da tela em questão. #### Returns Type: `Promise` O ID do recurso da aplicação. --- ### `getStringParam(name: string) => Promise` Obtém o valor de um parâmetro do tipo string. #### Returns Type: `Promise` O valor do parâmetro como string. --- ### `getUserID() => Promise` Obtém o UserId do usuário logado. #### Returns Type: `Promise` O ID do usuário. --- ### `hasAccess(access: AutorizationType, resourceID?: string) => Promise` Obtém `true` caso o usuário logado tenha permissão para determinada ação. #### Returns Type: `Promise` `true` se o usuário tiver acesso, `false` caso contrário. --- ### `hasClientEvent(eventID: String) => Promise` Verifica se um client event está registrado no DataFetcher da aplicação. #### Returns Type: `Promise` `true` se o evento estiver registrado, `false` caso contrário. --- ### `importScript(relativePath: string | Array) => Promise` Realiza o import de um JavaScript que está disponível dentro da pasta /public da aplicação. #### Returns Type: `Promise` --- ### `info(message: string, options?: MessageOptions) => Promise` Exibe uma informação efêmera (de segundo plano). #### Returns Type: `Promise` --- ### `initOnboarding(onboardingKey: string) => Promise` Inicializa o onboarding para uma chave específica. #### Returns Type: `Promise` --- ### `isDebugMode() => Promise` Obtém `true` caso a tela esteja em modo de debug. #### Returns Type: `Promise` --- ### `isFeatureActive(featureName: string) => Promise` Retorna se uma feature flag global está ativa ou não. #### Returns Type: `Promise` --- ### `isLoadedByPk() => Promise` Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk. #### Returns Type: `Promise` `true` se foi carregado por PK, `false` caso contrário. --- ### `isUserSup() => Promise` Obtém `true` caso o usuário logado seja o SUP. #### Returns Type: `Promise` `true` se o usuário for SUP, `false` caso contrário. --- ### `loadTotals(name: string, resourceID: string, filters: Array) => Promise>` Obtém os totalizadores da grade. #### Returns Type: `Promise>` Um mapa com os nomes dos totalizadores e seus valores. --- ### `markToReload(templateSkeletonType?: TEMPLATES_SKELETON) => Promise` Marca a aplicação para recarregar, opcionalmente especificando um tipo de esqueleto de carregamento. #### Returns Type: `Promise` --- ### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise` Exibe um diálogo de mensagem comum. #### Returns Type: `Promise` --- ### `openApp(resourceId: string, pkObject: Object) => Promise` Abre determinada tela, repassando pkObject. #### Returns Type: `Promise` --- ### `preloadMangerRemoveRecord(dataUnit: DataUnit, recordsIDs: Array) => Promise` Remove registro do cache do PreLoader do dataunit. Deve ser usado quando existe um dataunit usando loader do application, mas o removeLoader está sendo sobrescrito. #### Returns Type: `Promise` --- ### `removeClientEvent(eventID: String) => Promise` Remove um client event do DataFetcher da aplicação. #### Returns Type: `Promise` --- ### `saveConfig(key: string, data: Object) => Promise` Salva a configuração de determinado recurso. #### Returns Type: `Promise` O resultado da operação de salvamento. --- ### `setPopUpTitle(title: string) => Promise` #### Returns Type: `Promise` --- ### `setSearchFilterContext(name: string, value: string) => Promise` Atribui valor para parâmetros de contexto no componente de pesquisa. #### Returns Type: `Promise` --- ### `showAlerts(alerts: Array) => Promise` Apresenta uma lista de alertas. Geralmente é utilizado para apresentar resultados de processamentos em lote. #### Returns Type: `Promise` --- ### `showModal(content: HTMLElement) => Promise` Exibe o conteúdo passado em um Modal. #### Returns Type: `Promise` --- ### `showPopUp(content: HTMLElement, size?: "auto" | "full", useHeader?: boolean, onCloseCallback?: Function) => Promise` Exibe o conteúdo passado em um Popup. #### Returns Type: `Promise` --- ### `showScrimApp(active: boolean) => Promise` #### Returns Type: `Promise` --- ### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise` Exibe o diálogo de sucesso de acordo com os parâmetros passados. #### Returns Type: `Promise` --- ### `temOpcional(opcional: string) => Promise` Verifica se a licença do cliente tem determinado opcional (produto). #### Returns Type: `Promise` `true` se o cliente tiver o opcional, `false` caso contrário. --- ### `updateDataunitCache(oldName: string, dataUnitName: string, dataUnit: DataUnit) => Promise` Atualiza o cache de dataunits da aplicação. #### Returns Type: `Promise` --- ### `webConnection(keyPort: string, methodName: string, params: IAppletCallerParams) => Promise` Realiza a chamada do WebConnection para realizar a exportação de arquivo. #### Returns Type: `Promise` --- ### `whenApplicationReady() => Promise` Retorna uma promise que será resolvida quando o snk-application estiver carregado e registrado no ApplicationContext. #### Returns Type: `Promise` O componente SnkApplication carregado. ## Dependencies ### Used by - [teste-pesquisa](../teste-pesquisa) ### Depends on - [snk-pesquisa](../snk-pesquisa) ### Graph ```mermaid graph TD; snk-application --> snk-pesquisa snk-pesquisa --> pesquisa-grid snk-pesquisa --> pesquisa-tree teste-pesquisa --> snk-application style snk-application fill:#f9f,stroke:#333,stroke-width:4px ``` ----------------------------------------------