@sankhyalabs/sankhyablocks 9.1.0-dev.19 → 9.1.0-dev.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -112,22 +112,24 @@ export class SnkApplication {
112
112
  }
113
113
  /**
114
114
  * Obtém o controlador de teclado.
115
- *
116
- * @return {KeyboardManager} the keyboard manager
115
+ * @returns {Promise<KeyboardManager>} O gerenciador de teclado.
116
+ * @async
117
117
  */
118
118
  async getKeyboardManager() {
119
119
  return Promise.resolve(this._keyboardManager);
120
120
  }
121
121
  /**
122
- * Obtém o notificador de Layout de formulario.
123
- *
124
- * @return {LayoutFormConfig} the Configurador de Layout do Formulario
122
+ * Obtém o notificador de Layout de formulário.
123
+ * @returns {Promise<LayoutFormConfig>} O configurador de Layout do Formulário.
124
+ * @async
125
125
  */
126
126
  async getLayoutFormConfig() {
127
127
  return Promise.resolve(this._LayoutFormConfigSingleton);
128
128
  }
129
129
  /**
130
130
  * Obtém `true` caso o usuário logado seja o SUP.
131
+ * @returns {Promise<boolean>} `true` se o usuário for SUP, `false` caso contrário.
132
+ * @async
131
133
  */
132
134
  async isUserSup() {
133
135
  return new Promise((resolve, reject) => {
@@ -140,9 +142,10 @@ export class SnkApplication {
140
142
  }
141
143
  /**
142
144
  * Adiciona uma ação pendente que deve ser executada por um determinado locker.
143
- *
144
- * @param actionsLocker nome do locker da ação que será adicionada
145
- * @param action ação que será executada
145
+ * @param {string} actionsLocker - Nome do locker da ação que será adicionada.
146
+ * @param {Function} action - Ação que será executada.
147
+ * @returns {Promise<void>}
148
+ * @async
146
149
  */
147
150
  async addPendingAction(actionsLocker, action) {
148
151
  var _a;
@@ -150,15 +153,22 @@ export class SnkApplication {
150
153
  this._pendingActions.set(actionsLocker, [...actionsFromContext, action]);
151
154
  }
152
155
  /**
153
- * Realiza a chamada ao Service Broker conforme o nome do serviço.
154
- *
155
- * @param serviceName - Nome do serviço
156
- * @param payload - Dados que serão processados na ação
157
- * @param options - Parâmetros de URL
158
- */
156
+ * Realiza a chamada ao Service Broker conforme o nome do serviço.
157
+ * @param {string} serviceName - Nome do serviço.
158
+ * @param {string | Object} payload - Dados que serão processados na ação.
159
+ * @param {Options} [options] - Parâmetros de URL.
160
+ * @returns {Promise<any>} A resposta do Service Broker.
161
+ * @async
162
+ */
159
163
  async callServiceBroker(serviceName, payload, options) {
160
164
  return DataFetcher.get().callServiceBroker(serviceName, payload, options);
161
165
  }
166
+ /**
167
+ * Inicializa o onboarding para uma chave específica.
168
+ * @param {string} onboardingKey - A chave do onboarding a ser iniciado.
169
+ * @returns {Promise<void>}
170
+ * @async
171
+ */
162
172
  async initOnboarding(onboardingKey) {
163
173
  if (this.hasToShowNewVersionPopup()) {
164
174
  await this.addPendingAction(this.NEW_VERSION_POPUP_LOCKER, () => this.doInitOnboarding(onboardingKey));
@@ -170,7 +180,11 @@ export class SnkApplication {
170
180
  OnboardingUtils.getInstance().init(onboardingKey, window.envContext);
171
181
  }
172
182
  /**
173
- * Obtém `true` caso o usuário logado tem permissão pra determinada ação.
183
+ * Obtém `true` caso o usuário logado tenha permissão para determinada ação.
184
+ * @param {AutorizationType} access - O tipo de acesso a ser verificado.
185
+ * @param {string} [resourceID] - O ID do recurso para verificar a permissão. Se não fornecido, verifica a permissão da aplicação.
186
+ * @returns {Promise<boolean>} `true` se o usuário tiver acesso, `false` caso contrário.
187
+ * @async
174
188
  */
175
189
  async hasAccess(access, resourceID) {
176
190
  return new Promise((resolve, reject) => {
@@ -182,7 +196,10 @@ export class SnkApplication {
182
196
  });
183
197
  }
184
198
  /**
185
- * Obtém todos os acessos do usuário logado.
199
+ * Obtém todos os acessos do usuário logado para um recurso específico ou para a aplicação.
200
+ * @param {string} [resourceID] - O ID do recurso. Se não fornecido, obtém os acessos da aplicação.
201
+ * @returns {Promise<any>} Um objeto contendo todos os tipos de acesso e se o usuário os possui.
202
+ * @async
186
203
  */
187
204
  async getAllAccess(resourceID) {
188
205
  return new Promise((resolve, reject) => {
@@ -207,36 +224,57 @@ export class SnkApplication {
207
224
  }
208
225
  /**
209
226
  * Obtém o valor de um parâmetro do tipo string.
227
+ * @param {string} name - O nome do parâmetro.
228
+ * @returns {Promise<string>} O valor do parâmetro como string.
229
+ * @async
210
230
  */
211
231
  async getStringParam(name) {
212
232
  return this.parameters.asString(name);
213
233
  }
214
234
  /**
215
235
  * Obtém o valor de um parâmetro do tipo Inteiro.
236
+ * @param {string} name - O nome do parâmetro.
237
+ * @returns {Promise<number>} O valor do parâmetro como número inteiro.
238
+ * @async
216
239
  */
217
240
  async getIntParam(name) {
218
241
  return this.parameters.asInteger(name);
219
242
  }
220
243
  /**
221
244
  * Obtém o valor de um parâmetro do tipo Decimal.
245
+ * @param {string} name - O nome do parâmetro.
246
+ * @returns {Promise<number>} O valor do parâmetro como número decimal.
247
+ * @async
222
248
  */
223
249
  async getFloatParam(name) {
224
250
  return this.parameters.asFloat(name);
225
251
  }
226
252
  /**
227
253
  * Obtém o valor de um parâmetro do tipo booleano.
254
+ * @param {string} name - O nome do parâmetro.
255
+ * @returns {Promise<boolean>} O valor do parâmetro como booleano.
256
+ * @async
228
257
  */
229
258
  async getBooleanParam(name) {
230
259
  return this.parameters.asBoolean(name);
231
260
  }
232
261
  /**
233
262
  * Obtém o valor de um parâmetro do tipo data.
263
+ * @param {string} name - O nome do parâmetro.
264
+ * @returns {Promise<Date>} O valor do parâmetro como objeto Date.
265
+ * @async
234
266
  */
235
267
  async getDateParam(name) {
236
268
  return this.parameters.asDate(name);
237
269
  }
238
270
  /**
239
271
  * Exibe o conteúdo passado em um Popup.
272
+ * @param {HTMLElement} content - O elemento HTML a ser exibido no popup.
273
+ * @param {"auto" | "full"} [size="full"] - O tamanho do popup.
274
+ * @param {boolean} [useHeader=true] - Define se o cabeçalho do popup deve ser usado.
275
+ * @param {Function} [onCloseCallback] - Função a ser chamada quando o popup for fechado.
276
+ * @returns {Promise<void>}
277
+ * @async
240
278
  */
241
279
  async showPopUp(content, size = "full", useHeader = true, onCloseCallback) {
242
280
  this.clearContent(this._popUp);
@@ -253,6 +291,9 @@ export class SnkApplication {
253
291
  }
254
292
  /**
255
293
  * Exibe o conteúdo passado em um Modal.
294
+ * @param {HTMLElement} content - O elemento HTML a ser exibido no modal.
295
+ * @returns {Promise<void>}
296
+ * @async
256
297
  */
257
298
  async showModal(content) {
258
299
  this.clearContent(this._rightModal);
@@ -260,15 +301,18 @@ export class SnkApplication {
260
301
  this._rightModal.opened = true;
261
302
  }
262
303
  /**
263
- * Apresenta uma lista de alertas,
264
- * geralmente é utilizado para apresentar resultados
265
- * de processamentos em lote.
304
+ * Apresenta uma lista de alertas.
305
+ * Geralmente é utilizado para apresentar resultados de processamentos em lote.
306
+ * @param {Array<AlertItem>} alerts - A lista de alertas a serem exibidos.
307
+ * @returns {Promise<void>}
266
308
  */
267
309
  showAlerts(alerts) {
268
310
  return ApplicationUtils.showAlerts({ alerts });
269
311
  }
270
312
  /**
271
313
  * Fecha o Modal e limpa o conteúdo.
314
+ * @returns {Promise<void>}
315
+ * @async
272
316
  */
273
317
  async closeModal() {
274
318
  this.clearContent(this._rightModal);
@@ -276,6 +320,8 @@ export class SnkApplication {
276
320
  }
277
321
  /**
278
322
  * Fecha o Popup e limpa o conteúdo.
323
+ * @returns {Promise<void>}
324
+ * @async
279
325
  */
280
326
  async closePopUp() {
281
327
  this.clearContent(this._popUp);
@@ -284,7 +330,10 @@ export class SnkApplication {
284
330
  this._popUp.heightMode = "full";
285
331
  }
286
332
  /**
287
- * Verifica se a licença do cliente tem determinado opcional (produto)
333
+ * Verifica se a licença do cliente tem determinado opcional (produto).
334
+ * @param {string} opcional - O nome do opcional ou uma string de opcionais separados por vírgula.
335
+ * @returns {Promise<boolean>} `true` se o cliente tiver o opcional, `false` caso contrário.
336
+ * @async
288
337
  */
289
338
  async temOpcional(opcional) {
290
339
  const opts = opcional.split(",");
@@ -310,7 +359,10 @@ export class SnkApplication {
310
359
  });
311
360
  }
312
361
  /**
313
- * Obtém a configuração de um recurso por service broker
362
+ * Obtém a configuração de um recurso por service broker.
363
+ * @param {string} key - A chave da configuração.
364
+ * @returns {Promise<any>} Os dados da configuração.
365
+ * @async
314
366
  */
315
367
  async getConfig(key) {
316
368
  let payload = {
@@ -354,6 +406,10 @@ export class SnkApplication {
354
406
  }
355
407
  /**
356
408
  * Salva a configuração de determinado recurso.
409
+ * @param {string} key - A chave da configuração.
410
+ * @param {Object} data - Os dados da configuração a serem salvos.
411
+ * @returns {Promise<any>} O resultado da operação de salvamento.
412
+ * @async
357
413
  */
358
414
  async saveConfig(key, data) {
359
415
  let payload = {
@@ -375,21 +431,30 @@ export class SnkApplication {
375
431
  }
376
432
  /**
377
433
  * Acessa informações de contexto "empurrados" na abertura da tela.
434
+ * @param {string} attribName - O nome do atributo.
435
+ * @returns {Promise<string>} O valor do atributo.
436
+ * @async
378
437
  */
379
438
  async getAttributeFromHTMLWrapper(attribName) {
380
439
  return Promise.resolve(window[attribName]);
381
440
  }
382
441
  /**
383
442
  * Abre determinada tela, repassando pkObject.
443
+ * @param {string} resourceId - O ID do recurso da tela a ser aberta.
444
+ * @param {Object} pkObject - O objeto de chave primária a ser passado para a tela.
445
+ * @returns {Promise<void>}
446
+ * @async
384
447
  */
385
448
  async openApp(resourceId, pkObject) {
386
449
  Workspace.openAppActivity(resourceId, pkObject);
387
450
  }
388
451
  /**
389
452
  * Realiza a chamada do WebConnection para realizar a exportação de arquivo.
390
- * @param keyPort - Chave da porta que será requisitada.
391
- * @param methodName - Nome do tipo de exportação de arquivo que será realizado.
392
- * @param params - Parâmetros necessários para realizar a exportação do arquivo.
453
+ * @param {string} keyPort - Chave da porta que será requisitada.
454
+ * @param {string} methodName - Nome do tipo de exportação de arquivo que será realizado.
455
+ * @param {IAppletCallerParams} params - Parâmetros necessários para realizar a exportação do arquivo.
456
+ * @returns {Promise<void>}
457
+ * @async
393
458
  */
394
459
  async webConnection(keyPort, methodName, params) {
395
460
  this.getStringParam(keyPort).then((port) => {
@@ -410,6 +475,13 @@ export class SnkApplication {
410
475
  /**
411
476
  * Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
412
477
  * passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
478
+ * @param {string} entityName - O nome da entidade.
479
+ * @param {string} [dataUnitName] - O nome para identificar o DataUnit no cache.
480
+ * @param {DataUnit} [parentDataUnit] - O DataUnit pai, se houver.
481
+ * @param {string} [configName] - O nome da configuração a ser usada.
482
+ * @param {string} [resourceID] - O ID do recurso. Se não fornecido, usa o da aplicação.
483
+ * @returns {Promise<DataUnit>} O DataUnit criado ou obtido do cache.
484
+ * @async
413
485
  */
414
486
  async createDataunit(entityName, dataUnitName, parentDataUnit, configName, resourceID) {
415
487
  if (resourceID == undefined) {
@@ -441,9 +513,11 @@ export class SnkApplication {
441
513
  }
442
514
  /**
443
515
  * Atualiza o cache de dataunits da aplicação.
444
- * @param oldName - Nome do dataunit que está em cache.
445
- * @param dataUnitName - Nome do dataunit que será armazenado em cache.
446
- * @param dataUnit - Instancia do Dataunit para ser armazenado em cache.
516
+ * @param {string} oldName - Nome do dataunit que está em cache (será removido).
517
+ * @param {string} dataUnitName - Nome do dataunit que será armazenado em cache.
518
+ * @param {DataUnit} dataUnit - Instância do Dataunit para ser armazenado em cache.
519
+ * @returns {Promise<void>}
520
+ * @async
447
521
  */
448
522
  async updateDataunitCache(oldName, dataUnitName, dataUnit) {
449
523
  if (oldName) {
@@ -452,7 +526,14 @@ export class SnkApplication {
452
526
  this._duCache.set(dataUnitName, dataUnit);
453
527
  }
454
528
  /**
455
- * Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
529
+ * Obtém um DataUnit do cache ou cria um caso ainda não tenha sido criado.
530
+ * @param {string} entityName - O nome da entidade.
531
+ * @param {string} dataUnitName - O nome para identificar o DataUnit no cache.
532
+ * @param {DataUnit} [parentDataUnit] - O DataUnit pai, se houver.
533
+ * @param {string} [configName] - O nome da configuração a ser usada.
534
+ * @param {string} [resourceID] - O ID do recurso. Se não fornecido, usa o da aplicação.
535
+ * @returns {Promise<DataUnit>} O DataUnit obtido do cache ou recém-criado.
536
+ * @async
456
537
  */
457
538
  async getDataUnit(entityName, dataUnitName, parentDataUnit, configName, resourceID) {
458
539
  return new Promise((resolve, reject) => {
@@ -469,9 +550,10 @@ export class SnkApplication {
469
550
  }
470
551
  /**
471
552
  * Registra um client event para o DataFetcher da aplicação.
472
- *
473
- * @param eventID - Nome do evento para a aplicação se registrar.
474
- * @param handler - Função de callback que será chamada quando o client event ocorrer.
553
+ * @param {String} eventID - Nome do evento para a aplicação se registrar.
554
+ * @param {(clientEvent: IClientEventResponse, dataFetcherReacaller: IDataFetcherRecaller) => void} handler - Função de callback que será chamada quando o client event ocorrer.
555
+ * @returns {Promise<void>}
556
+ * @async
475
557
  */
476
558
  async addClientEvent(eventID, handler) {
477
559
  return new Promise((resolve) => {
@@ -480,9 +562,10 @@ export class SnkApplication {
480
562
  });
481
563
  }
482
564
  /**
483
- * Remove um client event para o DataFetcher da aplicação.
484
- *
485
- * @param eventID - Nome do evento a ser removido.
565
+ * Remove um client event do DataFetcher da aplicação.
566
+ * @param {String} eventID - Nome do evento a ser removido.
567
+ * @returns {Promise<void>}
568
+ * @async
486
569
  */
487
570
  async removeClientEvent(eventID) {
488
571
  return new Promise((resolve) => {
@@ -491,9 +574,10 @@ export class SnkApplication {
491
574
  });
492
575
  }
493
576
  /**
494
- * Verfica se um client event está registrado no DataFetcher da aplicação.
495
- *
496
- * @param eventID - Nome do evento a ser verificado.
577
+ * Verifica se um client event está registrado no DataFetcher da aplicação.
578
+ * @param {String} eventID - Nome do evento a ser verificado.
579
+ * @returns {Promise<boolean>} `true` se o evento estiver registrado, `false` caso contrário.
580
+ * @async
497
581
  */
498
582
  async hasClientEvent(eventID) {
499
583
  return new Promise((resolve) => {
@@ -511,61 +595,106 @@ export class SnkApplication {
511
595
  }
512
596
  /**
513
597
  * Obtém o resourceID da tela em questão.
598
+ * @returns {Promise<string>} O ID do recurso da aplicação.
599
+ * @async
514
600
  */
515
601
  async getResourceID() {
516
602
  return Promise.resolve(this.applicationResourceID);
517
603
  }
518
604
  /**
519
- * Obtém o UserId da tela em questão.
605
+ * Obtém o UserId do usuário logado.
606
+ * @returns {Promise<string>} O ID do usuário.
607
+ * @async
520
608
  */
521
609
  async getUserID() {
522
610
  return Promise.resolve(window["UID"]);
523
611
  }
524
612
  /**
525
613
  * Exibe o diálogo de alerta de acordo com os parâmetros passados.
614
+ * @param {string} title - O título do alerta.
615
+ * @param {string} message - A mensagem do alerta.
616
+ * @param {string} [icon] - O nome do ícone a ser exibido.
617
+ * @param {MessageOptions} [options] - Opções adicionais para a mensagem.
618
+ * @returns {Promise<boolean>}
619
+ * @async
526
620
  */
527
621
  async alert(title, message, icon, options) {
528
622
  return ApplicationUtils.alert(title, message, icon, options);
529
623
  }
530
624
  /**
531
625
  * Exibe o diálogo de erro de acordo com os parâmetros passados.
626
+ * @param {string} title - O título do erro.
627
+ * @param {string} message - A mensagem do erro.
628
+ * @param {string} [icon] - O nome do ícone a ser exibido.
629
+ * @param {MessageOptions} [options] - Opções adicionais para a mensagem.
630
+ * @returns {Promise<boolean>}
631
+ * @async
532
632
  */
533
633
  async error(title, message, icon, options) {
534
634
  return ApplicationUtils.error(title, message, icon, options);
535
635
  }
536
636
  /**
537
637
  * Exibe o diálogo de sucesso de acordo com os parâmetros passados.
638
+ * @param {string} title - O título da mensagem de sucesso.
639
+ * @param {string} message - A mensagem de sucesso.
640
+ * @param {string} [icon] - O nome do ícone a ser exibido.
641
+ * @param {MessageOptions} [options] - Opções adicionais para a mensagem.
642
+ * @returns {Promise<boolean>}
643
+ * @async
538
644
  */
539
645
  async success(title, message, icon, options) {
540
646
  return ApplicationUtils.success(title, message, icon, options);
541
647
  }
542
648
  /**
543
- * Exibe um diálogo de mensagem comum
649
+ * Exibe um diálogo de mensagem comum.
650
+ * @param {string} title - O título da mensagem.
651
+ * @param {string} message - A mensagem.
652
+ * @param {string} [icon] - O nome do ícone a ser exibido.
653
+ * @param {MessageOptions} [options] - Opções adicionais para a mensagem.
654
+ * @returns {Promise<boolean>}
655
+ * @async
544
656
  */
545
657
  async message(title, message, icon, options) {
546
658
  return ApplicationUtils.message(title, message, icon, options);
547
659
  }
548
660
  /**
549
- * Exibe um diálogo de confirmação
661
+ * Exibe um diálogo de confirmação.
662
+ * @param {string} title - O título da confirmação.
663
+ * @param {string} message - A mensagem da confirmação.
664
+ * @param {string} [icon] - O nome do ícone a ser exibido.
665
+ * @param {DialogType} [dialogType] - O tipo de diálogo.
666
+ * @param {MessageOptions} [options] - Opções adicionais para a mensagem.
667
+ * @returns {Promise<boolean>} `true` se confirmado, `false` caso contrário.
668
+ * @async
550
669
  */
551
670
  async confirm(title, message, icon, dialogType, options) {
552
671
  return ApplicationUtils.confirm(title, message, icon, dialogType, options);
553
672
  }
554
673
  /**
555
674
  * Exibe uma informação efêmera (de segundo plano).
675
+ * @param {string} message - A mensagem a ser exibida.
676
+ * @param {MessageOptions} [options] - Opções adicionais para a mensagem.
677
+ * @returns {Promise<void>}
678
+ * @async
556
679
  */
557
680
  async info(message, options) {
558
681
  return ApplicationUtils.info(message, options);
559
682
  }
560
683
  /**
561
684
  * Obtém os totalizadores da grade.
685
+ * @param {string} name - O nome da configuração de totalizadores.
686
+ * @param {string} resourceID - O ID do recurso.
687
+ * @param {Array<Filter>} filters - A lista de filtros a serem aplicados.
688
+ * @returns {Promise<Map<string, number>>} Um mapa com os nomes dos totalizadores e seus valores.
689
+ * @async
562
690
  */
563
691
  async loadTotals(name, resourceID, filters) {
564
692
  return this.totalsFetcher.fetchTotals(name, resourceID, filters);
565
693
  }
566
694
  /**
567
- * Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk
568
- * @returns boolean
695
+ * Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk.
696
+ * @returns {Promise<boolean>} `true` se foi carregado por PK, `false` caso contrário.
697
+ * @async
569
698
  */
570
699
  async isLoadedByPk() {
571
700
  return Promise.resolve(this._isLoadedByPk);
@@ -573,6 +702,10 @@ export class SnkApplication {
573
702
  /**
574
703
  * Remove registro do cache do PreLoader do dataunit.
575
704
  * Deve ser usado quando existe um dataunit usando loader do application, mas o removeLoader está sendo sobrescrito.
705
+ * @param {DataUnit} dataUnit - O DataUnit do qual o registro será removido.
706
+ * @param {Array<string>} recordsIDs - Os IDs dos registros a serem removidos.
707
+ * @returns {Promise<void>}
708
+ * @async
576
709
  */
577
710
  async preloadMangerRemoveRecord(dataUnit, recordsIDs) {
578
711
  const records = recordsIDs.map(id => {
@@ -632,8 +765,14 @@ export class SnkApplication {
632
765
  return this._authFetcher;
633
766
  }
634
767
  /**
635
- * Obtém as opções em componentes de pesquisa
768
+ * Obtém as opções em componentes de pesquisa.
636
769
  * Ex.: snk-config-options
770
+ * @param {ISearchArgument} searchArgument - Argumentos da pesquisa.
771
+ * @param {string} fieldName - Nome do campo no DataUnit.
772
+ * @param {DataUnit} dataUnit - Instância do DataUnit.
773
+ * @param {ISearchCtxOptions} [ctxOptions] - Opções de contexto adicionais.
774
+ * @returns {Promise<Array<IOption> | IOption>} Uma lista de opções ou uma única opção.
775
+ * @async
637
776
  */
638
777
  async executeSearch(searchArgument, fieldName, dataUnit, ctxOptions) {
639
778
  const descriptor = dataUnit === null || dataUnit === void 0 ? void 0 : dataUnit.getField(fieldName);
@@ -733,8 +872,11 @@ export class SnkApplication {
733
872
  return await this.executePreparedSearch(mode, argument, Object.assign(Object.assign({}, options), { useSearchPlus: true }));
734
873
  }
735
874
  /**
736
- * Obtém as opções em componentes de pesquisa
737
- * Ex.: snk-config-options
875
+ * @param {string} mode - O modo da pesquisa ("ADVANCED" ou outro).
876
+ * @param {string} argument - O argumento da pesquisa.
877
+ * @param {any} options - Opções preparadas para a pesquisa. Veja a documentação para exemplo de uso.
878
+ * @returns {Promise<Array<IOption> | IOption>} Uma lista de opções ou uma única opção.
879
+ * @async
738
880
  */
739
881
  async executePreparedSearch(mode, argument, options) {
740
882
  const mdByName = {};
@@ -794,14 +936,21 @@ export class SnkApplication {
794
936
  });
795
937
  }
796
938
  /**
797
- * Obtém o nome das telas da aplicação
939
+ * Obtém o nome (label) da aplicação.
940
+ * @returns {Promise<string>} O nome da aplicação.
941
+ * @async
798
942
  */
799
943
  async getAppLabel() {
800
944
  return Workspace.getAppLabel(this.applicationResourceID);
801
945
  }
802
946
  /**
803
- * Adiciona um listener no fetcher de Pesquisa
804
- */
947
+ * Adiciona um listener no fetcher de Pesquisa.
948
+ * @param {string} entityName - O nome da entidade.
949
+ * @param {DataUnit} dataUnit - A instância do DataUnit.
950
+ * @param {ISearchListener} listener - O listener a ser adicionado.
951
+ * @returns {Promise<IRemoveSearchListener>} Uma função para remover o listener.
952
+ * @async
953
+ */
805
954
  addSearchListener(entityName, dataUnit, listener) {
806
955
  return new Promise(resolve => {
807
956
  const removeListener = this.pesquisaFetcher.addSearchListener(entityName, dataUnit.dataUnitId, listener);
@@ -809,8 +958,10 @@ export class SnkApplication {
809
958
  });
810
959
  }
811
960
  /**
812
- Realiza o import de um JavaScript que está disponivel dentro da pasta /public da aplicação.
813
- @param relativePath: Define o caminho relativo para o arquivo JavaScript a ser importado.
961
+ Realiza o import de um JavaScript que está disponível dentro da pasta /public da aplicação.
962
+ @param {string | Array<string>} relativePath - Define o caminho relativo para o arquivo JavaScript a ser importado, ou uma lista de caminhos.
963
+ @returns {Promise<void>}
964
+ @async
814
965
  */
815
966
  importScript(relativePath) {
816
967
  return new Promise((resolve) => {
@@ -831,6 +982,8 @@ export class SnkApplication {
831
982
  }
832
983
  /**
833
984
  * Retorna o path relativo da aplicação.
985
+ * @returns {Promise<string>} O caminho relativo da aplicação.
986
+ * @async
834
987
  */
835
988
  async getApplicationPath() {
836
989
  return new Promise((resolve) => {
@@ -851,20 +1004,27 @@ export class SnkApplication {
851
1004
  * Com base em um campo realiza um "select distinct" respeitando os
852
1005
  * filtros atuais do dataUnit e um critério de filtro para a própria
853
1006
  * coluna.
1007
+ * @param {DataUnit} dataUnit - A instância do DataUnit.
1008
+ * @param {string} fieldName - O nome do campo para o select distinct.
1009
+ * @param {string} argument - O argumento de filtro para a coluna.
1010
+ * @returns {Promise<Array<any>>} Uma lista de valores distintos.
1011
+ * @async
854
1012
  */
855
1013
  executeSelectDistinct(dataUnit, fieldName, argument) {
856
1014
  return this.dataUnitFetcher.loadSelectDistinct(dataUnit, fieldName, argument);
857
1015
  }
858
1016
  /**
859
- * Retorna a instancia do DataFetcher utilizado pelo application
860
- * @returns DataFetcher do application
1017
+ * Retorna a instância do DataFetcher utilizado pelo application.
1018
+ * @returns {Promise<DataFetcher>} O DataFetcher da aplicação.
1019
+ * @async
861
1020
  */
862
1021
  getDataFetcher() {
863
1022
  return Promise.resolve(DataFetcher.get());
864
1023
  }
865
1024
  /**
866
- * Retorna uma promise que sera resolvida quando o snk-application estiver carregado e registrado no ApplicationContext
867
- * @returns SnkApplication carregado.
1025
+ * Retorna uma promise que será resolvida quando o snk-application estiver carregado e registrado no ApplicationContext.
1026
+ * @returns {Promise<SnkApplication>} O componente SnkApplication carregado.
1027
+ * @async
868
1028
  */
869
1029
  async whenApplicationReady() {
870
1030
  const isLoadding = ApplicationContext.getContextValue("__SNK__APPLICATION__LOADING__");
@@ -877,9 +1037,10 @@ export class SnkApplication {
877
1037
  }
878
1038
  /**
879
1039
  * Atribui valor para parâmetros de contexto no componente de pesquisa.
880
- *
881
- * @param name - Nome do parâmetro
882
- * @param value - String conversível de acordo com o tipo do parâmetro
1040
+ * @param {string} name - Nome do parâmetro.
1041
+ * @param {string} value - String conversível de acordo com o tipo do parâmetro.
1042
+ * @returns {Promise<void>}
1043
+ * @async
883
1044
  */
884
1045
  async setSearchFilterContext(name, value) {
885
1046
  ApplicationContext.setContextValue(`__SNK__APPLICATION__FILTER__CONTEXT(${name})__`, value);
@@ -1134,6 +1295,12 @@ export class SnkApplication {
1134
1295
  async changeTemplateSkeleton(templateSkeletonType) {
1135
1296
  this._templateSkeleton = templateSkeletonType ? templateSkeletonType : this._templateSkeleton;
1136
1297
  }
1298
+ /**
1299
+ * Marca a aplicação para recarregar, opcionalmente especificando um tipo de esqueleto de carregamento.
1300
+ * @param {TEMPLATES_SKELETON} [templateSkeletonType] - O tipo de esqueleto de carregamento a ser exibido.
1301
+ * @returns {Promise<void>}
1302
+ * @async
1303
+ */
1137
1304
  async markToReload(templateSkeletonType) {
1138
1305
  if (!this.enableLockManagerLoadingApp)
1139
1306
  return;
@@ -1142,6 +1309,13 @@ export class SnkApplication {
1142
1309
  await LockManager.resetLocks(this._element, LockManagerOperation.APP_LOADING);
1143
1310
  this.resolveApplicationReady();
1144
1311
  }
1312
+ /**
1313
+ * Adiciona um bloqueio de carregamento à aplicação.
1314
+ * @param {boolean} [forceReady=false] - Se `true`, força a aplicação para o estado "não pronto" antes de adicionar o bloqueio.
1315
+ * @param {TEMPLATES_SKELETON} [templateSkeletonType] - O tipo de esqueleto de carregamento a ser exibido.
1316
+ * @returns {Promise<string>} O ID do bloqueio adicionado.
1317
+ * @async
1318
+ */
1145
1319
  async addLoadingLock(forceReady = false, templateSkeletonType) {
1146
1320
  if (!this.enableLockManagerLoadingApp)
1147
1321
  return;
@@ -1272,7 +1446,7 @@ export class SnkApplication {
1272
1446
  "optional": false,
1273
1447
  "docs": {
1274
1448
  "tags": [],
1275
- "text": "Define se o componente deve usar o LockManager para controle de carregamento da aplica\u00E7\u00E3o"
1449
+ "text": "Define se o componente deve usar o LockManager para controle de carregamento da aplica\u00E7\u00E3o."
1276
1450
  },
1277
1451
  "attribute": "enable-lock-manager-loading-app",
1278
1452
  "reflect": false
@@ -1294,7 +1468,7 @@ export class SnkApplication {
1294
1468
  "optional": false,
1295
1469
  "docs": {
1296
1470
  "tags": [],
1297
- "text": ""
1471
+ "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
1298
1472
  }
1299
1473
  },
1300
1474
  "configName": {
@@ -1309,7 +1483,7 @@ export class SnkApplication {
1309
1483
  "optional": false,
1310
1484
  "docs": {
1311
1485
  "tags": [],
1312
- "text": "Usado para salvar as configura\u00E7\u00F5es dos blocos de constru\u00E7\u00E3o."
1486
+ "text": "Nome da configura\u00E7\u00E3o utilizada para salvar as prefer\u00EAncias dos blocos de constru\u00E7\u00E3o."
1313
1487
  },
1314
1488
  "attribute": "config-name",
1315
1489
  "reflect": false
@@ -1326,7 +1500,7 @@ export class SnkApplication {
1326
1500
  "optional": false,
1327
1501
  "docs": {
1328
1502
  "tags": [],
1329
- "text": "Chave da configura\u00E7\u00E3o legado da grade."
1503
+ "text": "Chave da configura\u00E7\u00E3o legada da grade, utilizada para migra\u00E7\u00E3o de configura\u00E7\u00F5es antigas."
1330
1504
  },
1331
1505
  "attribute": "grid-legacy-config-name",
1332
1506
  "reflect": false
@@ -1343,7 +1517,7 @@ export class SnkApplication {
1343
1517
  "optional": false,
1344
1518
  "docs": {
1345
1519
  "tags": [],
1346
- "text": "Chave da configura\u00E7\u00E3o legado do formul\u00E1rio."
1520
+ "text": "Chave da configura\u00E7\u00E3o legada do formul\u00E1rio, utilizada para migra\u00E7\u00E3o de configura\u00E7\u00F5es antigas."
1347
1521
  },
1348
1522
  "attribute": "form-legacy-config-name",
1349
1523
  "reflect": false
@@ -1429,8 +1603,11 @@ export class SnkApplication {
1429
1603
  "docs": {
1430
1604
  "text": "Obt\u00E9m o controlador de teclado.",
1431
1605
  "tags": [{
1432
- "name": "return",
1433
- "text": "the keyboard manager"
1606
+ "name": "returns",
1607
+ "text": "O gerenciador de teclado."
1608
+ }, {
1609
+ "name": "async",
1610
+ "text": undefined
1434
1611
  }]
1435
1612
  }
1436
1613
  },
@@ -1450,10 +1627,13 @@ export class SnkApplication {
1450
1627
  "return": "Promise<LayoutFormConfig>"
1451
1628
  },
1452
1629
  "docs": {
1453
- "text": "Obt\u00E9m o notificador de Layout de formulario.",
1630
+ "text": "Obt\u00E9m o notificador de Layout de formul\u00E1rio.",
1454
1631
  "tags": [{
1455
- "name": "return",
1456
- "text": "the Configurador de Layout do Formulario"
1632
+ "name": "returns",
1633
+ "text": "O configurador de Layout do Formul\u00E1rio."
1634
+ }, {
1635
+ "name": "async",
1636
+ "text": undefined
1457
1637
  }]
1458
1638
  }
1459
1639
  },
@@ -1470,7 +1650,13 @@ export class SnkApplication {
1470
1650
  },
1471
1651
  "docs": {
1472
1652
  "text": "Obt\u00E9m `true` caso o usu\u00E1rio logado seja o SUP.",
1473
- "tags": []
1653
+ "tags": [{
1654
+ "name": "returns",
1655
+ "text": "`true` se o usu\u00E1rio for SUP, `false` caso contr\u00E1rio."
1656
+ }, {
1657
+ "name": "async",
1658
+ "text": undefined
1659
+ }]
1474
1660
  }
1475
1661
  },
1476
1662
  "addPendingAction": {
@@ -1479,15 +1665,15 @@ export class SnkApplication {
1479
1665
  "parameters": [{
1480
1666
  "tags": [{
1481
1667
  "name": "param",
1482
- "text": "actionsLocker nome do locker da a\u00E7\u00E3o que ser\u00E1 adicionada"
1668
+ "text": "actionsLocker - Nome do locker da a\u00E7\u00E3o que ser\u00E1 adicionada."
1483
1669
  }],
1484
- "text": "nome do locker da a\u00E7\u00E3o que ser\u00E1 adicionada"
1670
+ "text": "- Nome do locker da a\u00E7\u00E3o que ser\u00E1 adicionada."
1485
1671
  }, {
1486
1672
  "tags": [{
1487
1673
  "name": "param",
1488
- "text": "action a\u00E7\u00E3o que ser\u00E1 executada"
1674
+ "text": "action - A\u00E7\u00E3o que ser\u00E1 executada."
1489
1675
  }],
1490
- "text": "a\u00E7\u00E3o que ser\u00E1 executada"
1676
+ "text": "- A\u00E7\u00E3o que ser\u00E1 executada."
1491
1677
  }],
1492
1678
  "references": {
1493
1679
  "Promise": {
@@ -1503,10 +1689,16 @@ export class SnkApplication {
1503
1689
  "text": "Adiciona uma a\u00E7\u00E3o pendente que deve ser executada por um determinado locker.",
1504
1690
  "tags": [{
1505
1691
  "name": "param",
1506
- "text": "actionsLocker nome do locker da a\u00E7\u00E3o que ser\u00E1 adicionada"
1692
+ "text": "actionsLocker - Nome do locker da a\u00E7\u00E3o que ser\u00E1 adicionada."
1507
1693
  }, {
1508
1694
  "name": "param",
1509
- "text": "action a\u00E7\u00E3o que ser\u00E1 executada"
1695
+ "text": "action - A\u00E7\u00E3o que ser\u00E1 executada."
1696
+ }, {
1697
+ "name": "returns",
1698
+ "text": undefined
1699
+ }, {
1700
+ "name": "async",
1701
+ "text": undefined
1510
1702
  }]
1511
1703
  }
1512
1704
  },
@@ -1516,21 +1708,21 @@ export class SnkApplication {
1516
1708
  "parameters": [{
1517
1709
  "tags": [{
1518
1710
  "name": "param",
1519
- "text": "serviceName - Nome do servi\u00E7o"
1711
+ "text": "serviceName - Nome do servi\u00E7o."
1520
1712
  }],
1521
- "text": "- Nome do servi\u00E7o"
1713
+ "text": "- Nome do servi\u00E7o."
1522
1714
  }, {
1523
1715
  "tags": [{
1524
1716
  "name": "param",
1525
- "text": "payload - Dados que ser\u00E3o processados na a\u00E7\u00E3o"
1717
+ "text": "payload - Dados que ser\u00E3o processados na a\u00E7\u00E3o."
1526
1718
  }],
1527
- "text": "- Dados que ser\u00E3o processados na a\u00E7\u00E3o"
1719
+ "text": "- Dados que ser\u00E3o processados na a\u00E7\u00E3o."
1528
1720
  }, {
1529
1721
  "tags": [{
1530
1722
  "name": "param",
1531
- "text": "options - Par\u00E2metros de URL"
1723
+ "text": "options - Par\u00E2metros de URL."
1532
1724
  }],
1533
- "text": "- Par\u00E2metros de URL"
1725
+ "text": "- Par\u00E2metros de URL."
1534
1726
  }],
1535
1727
  "references": {
1536
1728
  "Promise": {
@@ -1550,13 +1742,19 @@ export class SnkApplication {
1550
1742
  "text": "Realiza a chamada ao Service Broker conforme o nome do servi\u00E7o.",
1551
1743
  "tags": [{
1552
1744
  "name": "param",
1553
- "text": "serviceName - Nome do servi\u00E7o"
1745
+ "text": "serviceName - Nome do servi\u00E7o."
1554
1746
  }, {
1555
1747
  "name": "param",
1556
- "text": "payload - Dados que ser\u00E3o processados na a\u00E7\u00E3o"
1748
+ "text": "payload - Dados que ser\u00E3o processados na a\u00E7\u00E3o."
1557
1749
  }, {
1558
1750
  "name": "param",
1559
- "text": "options - Par\u00E2metros de URL"
1751
+ "text": "options - Par\u00E2metros de URL."
1752
+ }, {
1753
+ "name": "returns",
1754
+ "text": "A resposta do Service Broker."
1755
+ }, {
1756
+ "name": "async",
1757
+ "text": undefined
1560
1758
  }]
1561
1759
  }
1562
1760
  },
@@ -1564,8 +1762,11 @@ export class SnkApplication {
1564
1762
  "complexType": {
1565
1763
  "signature": "(onboardingKey: string) => Promise<void>",
1566
1764
  "parameters": [{
1567
- "tags": [],
1568
- "text": ""
1765
+ "tags": [{
1766
+ "name": "param",
1767
+ "text": "onboardingKey - A chave do onboarding a ser iniciado."
1768
+ }],
1769
+ "text": "- A chave do onboarding a ser iniciado."
1569
1770
  }],
1570
1771
  "references": {
1571
1772
  "Promise": {
@@ -1575,19 +1776,34 @@ export class SnkApplication {
1575
1776
  "return": "Promise<void>"
1576
1777
  },
1577
1778
  "docs": {
1578
- "text": "",
1579
- "tags": []
1779
+ "text": "Inicializa o onboarding para uma chave espec\u00EDfica.",
1780
+ "tags": [{
1781
+ "name": "param",
1782
+ "text": "onboardingKey - A chave do onboarding a ser iniciado."
1783
+ }, {
1784
+ "name": "returns",
1785
+ "text": undefined
1786
+ }, {
1787
+ "name": "async",
1788
+ "text": undefined
1789
+ }]
1580
1790
  }
1581
1791
  },
1582
1792
  "hasAccess": {
1583
1793
  "complexType": {
1584
1794
  "signature": "(access: AutorizationType, resourceID?: string) => Promise<boolean>",
1585
1795
  "parameters": [{
1586
- "tags": [],
1587
- "text": ""
1796
+ "tags": [{
1797
+ "name": "param",
1798
+ "text": "access - O tipo de acesso a ser verificado."
1799
+ }],
1800
+ "text": "- O tipo de acesso a ser verificado."
1588
1801
  }, {
1589
- "tags": [],
1590
- "text": ""
1802
+ "tags": [{
1803
+ "name": "param",
1804
+ "text": "resourceID - O ID do recurso para verificar a permiss\u00E3o. Se n\u00E3o fornecido, verifica a permiss\u00E3o da aplica\u00E7\u00E3o."
1805
+ }],
1806
+ "text": "- O ID do recurso para verificar a permiss\u00E3o. Se n\u00E3o fornecido, verifica a permiss\u00E3o da aplica\u00E7\u00E3o."
1591
1807
  }],
1592
1808
  "references": {
1593
1809
  "Promise": {
@@ -1601,16 +1817,31 @@ export class SnkApplication {
1601
1817
  "return": "Promise<boolean>"
1602
1818
  },
1603
1819
  "docs": {
1604
- "text": "Obt\u00E9m `true` caso o usu\u00E1rio logado tem permiss\u00E3o pra determinada a\u00E7\u00E3o.",
1605
- "tags": []
1820
+ "text": "Obt\u00E9m `true` caso o usu\u00E1rio logado tenha permiss\u00E3o para determinada a\u00E7\u00E3o.",
1821
+ "tags": [{
1822
+ "name": "param",
1823
+ "text": "access - O tipo de acesso a ser verificado."
1824
+ }, {
1825
+ "name": "param",
1826
+ "text": "resourceID - O ID do recurso para verificar a permiss\u00E3o. Se n\u00E3o fornecido, verifica a permiss\u00E3o da aplica\u00E7\u00E3o."
1827
+ }, {
1828
+ "name": "returns",
1829
+ "text": "`true` se o usu\u00E1rio tiver acesso, `false` caso contr\u00E1rio."
1830
+ }, {
1831
+ "name": "async",
1832
+ "text": undefined
1833
+ }]
1606
1834
  }
1607
1835
  },
1608
1836
  "getAllAccess": {
1609
1837
  "complexType": {
1610
1838
  "signature": "(resourceID?: string) => Promise<any>",
1611
1839
  "parameters": [{
1612
- "tags": [],
1613
- "text": ""
1840
+ "tags": [{
1841
+ "name": "param",
1842
+ "text": "resourceID - O ID do recurso. Se n\u00E3o fornecido, obt\u00E9m os acessos da aplica\u00E7\u00E3o."
1843
+ }],
1844
+ "text": "- O ID do recurso. Se n\u00E3o fornecido, obt\u00E9m os acessos da aplica\u00E7\u00E3o."
1614
1845
  }],
1615
1846
  "references": {
1616
1847
  "Promise": {
@@ -1620,16 +1851,28 @@ export class SnkApplication {
1620
1851
  "return": "Promise<any>"
1621
1852
  },
1622
1853
  "docs": {
1623
- "text": "Obt\u00E9m todos os acessos do usu\u00E1rio logado.",
1624
- "tags": []
1854
+ "text": "Obt\u00E9m todos os acessos do usu\u00E1rio logado para um recurso espec\u00EDfico ou para a aplica\u00E7\u00E3o.",
1855
+ "tags": [{
1856
+ "name": "param",
1857
+ "text": "resourceID - O ID do recurso. Se n\u00E3o fornecido, obt\u00E9m os acessos da aplica\u00E7\u00E3o."
1858
+ }, {
1859
+ "name": "returns",
1860
+ "text": "Um objeto contendo todos os tipos de acesso e se o usu\u00E1rio os possui."
1861
+ }, {
1862
+ "name": "async",
1863
+ "text": undefined
1864
+ }]
1625
1865
  }
1626
1866
  },
1627
1867
  "getStringParam": {
1628
1868
  "complexType": {
1629
1869
  "signature": "(name: string) => Promise<string>",
1630
1870
  "parameters": [{
1631
- "tags": [],
1632
- "text": ""
1871
+ "tags": [{
1872
+ "name": "param",
1873
+ "text": "name - O nome do par\u00E2metro."
1874
+ }],
1875
+ "text": "- O nome do par\u00E2metro."
1633
1876
  }],
1634
1877
  "references": {
1635
1878
  "Promise": {
@@ -1640,15 +1883,27 @@ export class SnkApplication {
1640
1883
  },
1641
1884
  "docs": {
1642
1885
  "text": "Obt\u00E9m o valor de um par\u00E2metro do tipo string.",
1643
- "tags": []
1886
+ "tags": [{
1887
+ "name": "param",
1888
+ "text": "name - O nome do par\u00E2metro."
1889
+ }, {
1890
+ "name": "returns",
1891
+ "text": "O valor do par\u00E2metro como string."
1892
+ }, {
1893
+ "name": "async",
1894
+ "text": undefined
1895
+ }]
1644
1896
  }
1645
1897
  },
1646
1898
  "getIntParam": {
1647
1899
  "complexType": {
1648
1900
  "signature": "(name: string) => Promise<number>",
1649
1901
  "parameters": [{
1650
- "tags": [],
1651
- "text": ""
1902
+ "tags": [{
1903
+ "name": "param",
1904
+ "text": "name - O nome do par\u00E2metro."
1905
+ }],
1906
+ "text": "- O nome do par\u00E2metro."
1652
1907
  }],
1653
1908
  "references": {
1654
1909
  "Promise": {
@@ -1659,15 +1914,27 @@ export class SnkApplication {
1659
1914
  },
1660
1915
  "docs": {
1661
1916
  "text": "Obt\u00E9m o valor de um par\u00E2metro do tipo Inteiro.",
1662
- "tags": []
1917
+ "tags": [{
1918
+ "name": "param",
1919
+ "text": "name - O nome do par\u00E2metro."
1920
+ }, {
1921
+ "name": "returns",
1922
+ "text": "O valor do par\u00E2metro como n\u00FAmero inteiro."
1923
+ }, {
1924
+ "name": "async",
1925
+ "text": undefined
1926
+ }]
1663
1927
  }
1664
1928
  },
1665
1929
  "getFloatParam": {
1666
1930
  "complexType": {
1667
1931
  "signature": "(name: string) => Promise<number>",
1668
1932
  "parameters": [{
1669
- "tags": [],
1670
- "text": ""
1933
+ "tags": [{
1934
+ "name": "param",
1935
+ "text": "name - O nome do par\u00E2metro."
1936
+ }],
1937
+ "text": "- O nome do par\u00E2metro."
1671
1938
  }],
1672
1939
  "references": {
1673
1940
  "Promise": {
@@ -1678,15 +1945,27 @@ export class SnkApplication {
1678
1945
  },
1679
1946
  "docs": {
1680
1947
  "text": "Obt\u00E9m o valor de um par\u00E2metro do tipo Decimal.",
1681
- "tags": []
1948
+ "tags": [{
1949
+ "name": "param",
1950
+ "text": "name - O nome do par\u00E2metro."
1951
+ }, {
1952
+ "name": "returns",
1953
+ "text": "O valor do par\u00E2metro como n\u00FAmero decimal."
1954
+ }, {
1955
+ "name": "async",
1956
+ "text": undefined
1957
+ }]
1682
1958
  }
1683
1959
  },
1684
1960
  "getBooleanParam": {
1685
1961
  "complexType": {
1686
1962
  "signature": "(name: string) => Promise<boolean>",
1687
1963
  "parameters": [{
1688
- "tags": [],
1689
- "text": ""
1964
+ "tags": [{
1965
+ "name": "param",
1966
+ "text": "name - O nome do par\u00E2metro."
1967
+ }],
1968
+ "text": "- O nome do par\u00E2metro."
1690
1969
  }],
1691
1970
  "references": {
1692
1971
  "Promise": {
@@ -1697,15 +1976,27 @@ export class SnkApplication {
1697
1976
  },
1698
1977
  "docs": {
1699
1978
  "text": "Obt\u00E9m o valor de um par\u00E2metro do tipo booleano.",
1700
- "tags": []
1979
+ "tags": [{
1980
+ "name": "param",
1981
+ "text": "name - O nome do par\u00E2metro."
1982
+ }, {
1983
+ "name": "returns",
1984
+ "text": "O valor do par\u00E2metro como booleano."
1985
+ }, {
1986
+ "name": "async",
1987
+ "text": undefined
1988
+ }]
1701
1989
  }
1702
1990
  },
1703
1991
  "getDateParam": {
1704
1992
  "complexType": {
1705
1993
  "signature": "(name: string) => Promise<Date>",
1706
1994
  "parameters": [{
1707
- "tags": [],
1708
- "text": ""
1995
+ "tags": [{
1996
+ "name": "param",
1997
+ "text": "name - O nome do par\u00E2metro."
1998
+ }],
1999
+ "text": "- O nome do par\u00E2metro."
1709
2000
  }],
1710
2001
  "references": {
1711
2002
  "Promise": {
@@ -1719,24 +2010,45 @@ export class SnkApplication {
1719
2010
  },
1720
2011
  "docs": {
1721
2012
  "text": "Obt\u00E9m o valor de um par\u00E2metro do tipo data.",
1722
- "tags": []
2013
+ "tags": [{
2014
+ "name": "param",
2015
+ "text": "name - O nome do par\u00E2metro."
2016
+ }, {
2017
+ "name": "returns",
2018
+ "text": "O valor do par\u00E2metro como objeto Date."
2019
+ }, {
2020
+ "name": "async",
2021
+ "text": undefined
2022
+ }]
1723
2023
  }
1724
2024
  },
1725
2025
  "showPopUp": {
1726
2026
  "complexType": {
1727
2027
  "signature": "(content: HTMLElement, size?: \"auto\" | \"full\", useHeader?: boolean, onCloseCallback?: Function) => Promise<void>",
1728
2028
  "parameters": [{
1729
- "tags": [],
1730
- "text": ""
2029
+ "tags": [{
2030
+ "name": "param",
2031
+ "text": "content - O elemento HTML a ser exibido no popup."
2032
+ }],
2033
+ "text": "- O elemento HTML a ser exibido no popup."
1731
2034
  }, {
1732
- "tags": [],
1733
- "text": ""
2035
+ "tags": [{
2036
+ "name": "param",
2037
+ "text": "size - O tamanho do popup."
2038
+ }],
2039
+ "text": "- O tamanho do popup."
1734
2040
  }, {
1735
- "tags": [],
1736
- "text": ""
2041
+ "tags": [{
2042
+ "name": "param",
2043
+ "text": "useHeader - Define se o cabe\u00E7alho do popup deve ser usado."
2044
+ }],
2045
+ "text": "- Define se o cabe\u00E7alho do popup deve ser usado."
1737
2046
  }, {
1738
- "tags": [],
1739
- "text": ""
2047
+ "tags": [{
2048
+ "name": "param",
2049
+ "text": "onCloseCallback - Fun\u00E7\u00E3o a ser chamada quando o popup for fechado."
2050
+ }],
2051
+ "text": "- Fun\u00E7\u00E3o a ser chamada quando o popup for fechado."
1740
2052
  }],
1741
2053
  "references": {
1742
2054
  "Promise": {
@@ -1753,15 +2065,36 @@ export class SnkApplication {
1753
2065
  },
1754
2066
  "docs": {
1755
2067
  "text": "Exibe o conte\u00FAdo passado em um Popup.",
1756
- "tags": []
2068
+ "tags": [{
2069
+ "name": "param",
2070
+ "text": "content - O elemento HTML a ser exibido no popup."
2071
+ }, {
2072
+ "name": "param",
2073
+ "text": "size - O tamanho do popup."
2074
+ }, {
2075
+ "name": "param",
2076
+ "text": "useHeader - Define se o cabe\u00E7alho do popup deve ser usado."
2077
+ }, {
2078
+ "name": "param",
2079
+ "text": "onCloseCallback - Fun\u00E7\u00E3o a ser chamada quando o popup for fechado."
2080
+ }, {
2081
+ "name": "returns",
2082
+ "text": undefined
2083
+ }, {
2084
+ "name": "async",
2085
+ "text": undefined
2086
+ }]
1757
2087
  }
1758
2088
  },
1759
2089
  "showModal": {
1760
2090
  "complexType": {
1761
2091
  "signature": "(content: HTMLElement) => Promise<void>",
1762
2092
  "parameters": [{
1763
- "tags": [],
1764
- "text": ""
2093
+ "tags": [{
2094
+ "name": "param",
2095
+ "text": "content - O elemento HTML a ser exibido no modal."
2096
+ }],
2097
+ "text": "- O elemento HTML a ser exibido no modal."
1765
2098
  }],
1766
2099
  "references": {
1767
2100
  "Promise": {
@@ -1775,15 +2108,27 @@ export class SnkApplication {
1775
2108
  },
1776
2109
  "docs": {
1777
2110
  "text": "Exibe o conte\u00FAdo passado em um Modal.",
1778
- "tags": []
2111
+ "tags": [{
2112
+ "name": "param",
2113
+ "text": "content - O elemento HTML a ser exibido no modal."
2114
+ }, {
2115
+ "name": "returns",
2116
+ "text": undefined
2117
+ }, {
2118
+ "name": "async",
2119
+ "text": undefined
2120
+ }]
1779
2121
  }
1780
2122
  },
1781
2123
  "showAlerts": {
1782
2124
  "complexType": {
1783
2125
  "signature": "(alerts: Array<AlertItem>) => Promise<void>",
1784
2126
  "parameters": [{
1785
- "tags": [],
1786
- "text": ""
2127
+ "tags": [{
2128
+ "name": "param",
2129
+ "text": "alerts - A lista de alertas a serem exibidos."
2130
+ }],
2131
+ "text": "- A lista de alertas a serem exibidos."
1787
2132
  }],
1788
2133
  "references": {
1789
2134
  "Promise": {
@@ -1800,8 +2145,14 @@ export class SnkApplication {
1800
2145
  "return": "Promise<void>"
1801
2146
  },
1802
2147
  "docs": {
1803
- "text": "Apresenta uma lista de alertas,\ngeralmente \u00E9 utilizado para apresentar resultados\nde processamentos em lote.",
1804
- "tags": []
2148
+ "text": "Apresenta uma lista de alertas.\nGeralmente \u00E9 utilizado para apresentar resultados de processamentos em lote.",
2149
+ "tags": [{
2150
+ "name": "param",
2151
+ "text": "alerts - A lista de alertas a serem exibidos."
2152
+ }, {
2153
+ "name": "returns",
2154
+ "text": undefined
2155
+ }]
1805
2156
  }
1806
2157
  },
1807
2158
  "closeModal": {
@@ -1817,7 +2168,13 @@ export class SnkApplication {
1817
2168
  },
1818
2169
  "docs": {
1819
2170
  "text": "Fecha o Modal e limpa o conte\u00FAdo.",
1820
- "tags": []
2171
+ "tags": [{
2172
+ "name": "returns",
2173
+ "text": undefined
2174
+ }, {
2175
+ "name": "async",
2176
+ "text": undefined
2177
+ }]
1821
2178
  }
1822
2179
  },
1823
2180
  "closePopUp": {
@@ -1833,15 +2190,24 @@ export class SnkApplication {
1833
2190
  },
1834
2191
  "docs": {
1835
2192
  "text": "Fecha o Popup e limpa o conte\u00FAdo.",
1836
- "tags": []
2193
+ "tags": [{
2194
+ "name": "returns",
2195
+ "text": undefined
2196
+ }, {
2197
+ "name": "async",
2198
+ "text": undefined
2199
+ }]
1837
2200
  }
1838
2201
  },
1839
2202
  "temOpcional": {
1840
2203
  "complexType": {
1841
2204
  "signature": "(opcional: string) => Promise<boolean>",
1842
2205
  "parameters": [{
1843
- "tags": [],
1844
- "text": ""
2206
+ "tags": [{
2207
+ "name": "param",
2208
+ "text": "opcional - O nome do opcional ou uma string de opcionais separados por v\u00EDrgula."
2209
+ }],
2210
+ "text": "- O nome do opcional ou uma string de opcionais separados por v\u00EDrgula."
1845
2211
  }],
1846
2212
  "references": {
1847
2213
  "Promise": {
@@ -1851,16 +2217,28 @@ export class SnkApplication {
1851
2217
  "return": "Promise<boolean>"
1852
2218
  },
1853
2219
  "docs": {
1854
- "text": "Verifica se a licen\u00E7a do cliente tem determinado opcional (produto)",
1855
- "tags": []
2220
+ "text": "Verifica se a licen\u00E7a do cliente tem determinado opcional (produto).",
2221
+ "tags": [{
2222
+ "name": "param",
2223
+ "text": "opcional - O nome do opcional ou uma string de opcionais separados por v\u00EDrgula."
2224
+ }, {
2225
+ "name": "returns",
2226
+ "text": "`true` se o cliente tiver o opcional, `false` caso contr\u00E1rio."
2227
+ }, {
2228
+ "name": "async",
2229
+ "text": undefined
2230
+ }]
1856
2231
  }
1857
2232
  },
1858
2233
  "getConfig": {
1859
2234
  "complexType": {
1860
2235
  "signature": "(key: string) => Promise<any>",
1861
2236
  "parameters": [{
1862
- "tags": [],
1863
- "text": ""
2237
+ "tags": [{
2238
+ "name": "param",
2239
+ "text": "key - A chave da configura\u00E7\u00E3o."
2240
+ }],
2241
+ "text": "- A chave da configura\u00E7\u00E3o."
1864
2242
  }],
1865
2243
  "references": {
1866
2244
  "Promise": {
@@ -1870,8 +2248,17 @@ export class SnkApplication {
1870
2248
  "return": "Promise<any>"
1871
2249
  },
1872
2250
  "docs": {
1873
- "text": "Obt\u00E9m a configura\u00E7\u00E3o de um recurso por service broker",
1874
- "tags": []
2251
+ "text": "Obt\u00E9m a configura\u00E7\u00E3o de um recurso por service broker.",
2252
+ "tags": [{
2253
+ "name": "param",
2254
+ "text": "key - A chave da configura\u00E7\u00E3o."
2255
+ }, {
2256
+ "name": "returns",
2257
+ "text": "Os dados da configura\u00E7\u00E3o."
2258
+ }, {
2259
+ "name": "async",
2260
+ "text": undefined
2261
+ }]
1875
2262
  }
1876
2263
  },
1877
2264
  "isFeatureActive": {
@@ -1897,11 +2284,17 @@ export class SnkApplication {
1897
2284
  "complexType": {
1898
2285
  "signature": "(key: string, data: Object) => Promise<any>",
1899
2286
  "parameters": [{
1900
- "tags": [],
1901
- "text": ""
2287
+ "tags": [{
2288
+ "name": "param",
2289
+ "text": "key - A chave da configura\u00E7\u00E3o."
2290
+ }],
2291
+ "text": "- A chave da configura\u00E7\u00E3o."
1902
2292
  }, {
1903
- "tags": [],
1904
- "text": ""
2293
+ "tags": [{
2294
+ "name": "param",
2295
+ "text": "data - Os dados da configura\u00E7\u00E3o a serem salvos."
2296
+ }],
2297
+ "text": "- Os dados da configura\u00E7\u00E3o a serem salvos."
1905
2298
  }],
1906
2299
  "references": {
1907
2300
  "Promise": {
@@ -1915,15 +2308,30 @@ export class SnkApplication {
1915
2308
  },
1916
2309
  "docs": {
1917
2310
  "text": "Salva a configura\u00E7\u00E3o de determinado recurso.",
1918
- "tags": []
2311
+ "tags": [{
2312
+ "name": "param",
2313
+ "text": "key - A chave da configura\u00E7\u00E3o."
2314
+ }, {
2315
+ "name": "param",
2316
+ "text": "data - Os dados da configura\u00E7\u00E3o a serem salvos."
2317
+ }, {
2318
+ "name": "returns",
2319
+ "text": "O resultado da opera\u00E7\u00E3o de salvamento."
2320
+ }, {
2321
+ "name": "async",
2322
+ "text": undefined
2323
+ }]
1919
2324
  }
1920
2325
  },
1921
2326
  "getAttributeFromHTMLWrapper": {
1922
2327
  "complexType": {
1923
2328
  "signature": "(attribName: string) => Promise<string>",
1924
2329
  "parameters": [{
1925
- "tags": [],
1926
- "text": ""
2330
+ "tags": [{
2331
+ "name": "param",
2332
+ "text": "attribName - O nome do atributo."
2333
+ }],
2334
+ "text": "- O nome do atributo."
1927
2335
  }],
1928
2336
  "references": {
1929
2337
  "Promise": {
@@ -1934,18 +2342,33 @@ export class SnkApplication {
1934
2342
  },
1935
2343
  "docs": {
1936
2344
  "text": "Acessa informa\u00E7\u00F5es de contexto \"empurrados\" na abertura da tela.",
1937
- "tags": []
2345
+ "tags": [{
2346
+ "name": "param",
2347
+ "text": "attribName - O nome do atributo."
2348
+ }, {
2349
+ "name": "returns",
2350
+ "text": "O valor do atributo."
2351
+ }, {
2352
+ "name": "async",
2353
+ "text": undefined
2354
+ }]
1938
2355
  }
1939
2356
  },
1940
2357
  "openApp": {
1941
2358
  "complexType": {
1942
2359
  "signature": "(resourceId: string, pkObject: Object) => Promise<void>",
1943
2360
  "parameters": [{
1944
- "tags": [],
1945
- "text": ""
2361
+ "tags": [{
2362
+ "name": "param",
2363
+ "text": "resourceId - O ID do recurso da tela a ser aberta."
2364
+ }],
2365
+ "text": "- O ID do recurso da tela a ser aberta."
1946
2366
  }, {
1947
- "tags": [],
1948
- "text": ""
2367
+ "tags": [{
2368
+ "name": "param",
2369
+ "text": "pkObject - O objeto de chave prim\u00E1ria a ser passado para a tela."
2370
+ }],
2371
+ "text": "- O objeto de chave prim\u00E1ria a ser passado para a tela."
1949
2372
  }],
1950
2373
  "references": {
1951
2374
  "Promise": {
@@ -1959,7 +2382,19 @@ export class SnkApplication {
1959
2382
  },
1960
2383
  "docs": {
1961
2384
  "text": "Abre determinada tela, repassando pkObject.",
1962
- "tags": []
2385
+ "tags": [{
2386
+ "name": "param",
2387
+ "text": "resourceId - O ID do recurso da tela a ser aberta."
2388
+ }, {
2389
+ "name": "param",
2390
+ "text": "pkObject - O objeto de chave prim\u00E1ria a ser passado para a tela."
2391
+ }, {
2392
+ "name": "returns",
2393
+ "text": undefined
2394
+ }, {
2395
+ "name": "async",
2396
+ "text": undefined
2397
+ }]
1963
2398
  }
1964
2399
  },
1965
2400
  "webConnection": {
@@ -2006,6 +2441,12 @@ export class SnkApplication {
2006
2441
  }, {
2007
2442
  "name": "param",
2008
2443
  "text": "params - Par\u00E2metros necess\u00E1rios para realizar a exporta\u00E7\u00E3o do arquivo."
2444
+ }, {
2445
+ "name": "returns",
2446
+ "text": undefined
2447
+ }, {
2448
+ "name": "async",
2449
+ "text": undefined
2009
2450
  }]
2010
2451
  }
2011
2452
  },
@@ -2013,20 +2454,35 @@ export class SnkApplication {
2013
2454
  "complexType": {
2014
2455
  "signature": "(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>",
2015
2456
  "parameters": [{
2016
- "tags": [],
2017
- "text": ""
2457
+ "tags": [{
2458
+ "name": "param",
2459
+ "text": "entityName - O nome da entidade."
2460
+ }],
2461
+ "text": "- O nome da entidade."
2018
2462
  }, {
2019
- "tags": [],
2020
- "text": ""
2463
+ "tags": [{
2464
+ "name": "param",
2465
+ "text": "dataUnitName - O nome para identificar o DataUnit no cache."
2466
+ }],
2467
+ "text": "- O nome para identificar o DataUnit no cache."
2021
2468
  }, {
2022
- "tags": [],
2023
- "text": ""
2469
+ "tags": [{
2470
+ "name": "param",
2471
+ "text": "parentDataUnit - O DataUnit pai, se houver."
2472
+ }],
2473
+ "text": "- O DataUnit pai, se houver."
2024
2474
  }, {
2025
- "tags": [],
2026
- "text": ""
2475
+ "tags": [{
2476
+ "name": "param",
2477
+ "text": "configName - O nome da configura\u00E7\u00E3o a ser usada."
2478
+ }],
2479
+ "text": "- O nome da configura\u00E7\u00E3o a ser usada."
2027
2480
  }, {
2028
- "tags": [],
2029
- "text": ""
2481
+ "tags": [{
2482
+ "name": "param",
2483
+ "text": "resourceID - O ID do recurso. Se n\u00E3o fornecido, usa o da aplica\u00E7\u00E3o."
2484
+ }],
2485
+ "text": "- O ID do recurso. Se n\u00E3o fornecido, usa o da aplica\u00E7\u00E3o."
2030
2486
  }],
2031
2487
  "references": {
2032
2488
  "Promise": {
@@ -2041,7 +2497,28 @@ export class SnkApplication {
2041
2497
  },
2042
2498
  "docs": {
2043
2499
  "text": "Cria o DataUnit a partir do nome da entidade. \u00C9 poss\u00EDvel armazen\u00E1-lo no cache\npassando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit ser\u00E1 usado.",
2044
- "tags": []
2500
+ "tags": [{
2501
+ "name": "param",
2502
+ "text": "entityName - O nome da entidade."
2503
+ }, {
2504
+ "name": "param",
2505
+ "text": "dataUnitName - O nome para identificar o DataUnit no cache."
2506
+ }, {
2507
+ "name": "param",
2508
+ "text": "parentDataUnit - O DataUnit pai, se houver."
2509
+ }, {
2510
+ "name": "param",
2511
+ "text": "configName - O nome da configura\u00E7\u00E3o a ser usada."
2512
+ }, {
2513
+ "name": "param",
2514
+ "text": "resourceID - O ID do recurso. Se n\u00E3o fornecido, usa o da aplica\u00E7\u00E3o."
2515
+ }, {
2516
+ "name": "returns",
2517
+ "text": "O DataUnit criado ou obtido do cache."
2518
+ }, {
2519
+ "name": "async",
2520
+ "text": undefined
2521
+ }]
2045
2522
  }
2046
2523
  },
2047
2524
  "updateDataunitCache": {
@@ -2050,9 +2527,9 @@ export class SnkApplication {
2050
2527
  "parameters": [{
2051
2528
  "tags": [{
2052
2529
  "name": "param",
2053
- "text": "oldName - Nome do dataunit que est\u00E1 em cache."
2530
+ "text": "oldName - Nome do dataunit que est\u00E1 em cache (ser\u00E1 removido)."
2054
2531
  }],
2055
- "text": "- Nome do dataunit que est\u00E1 em cache."
2532
+ "text": "- Nome do dataunit que est\u00E1 em cache (ser\u00E1 removido)."
2056
2533
  }, {
2057
2534
  "tags": [{
2058
2535
  "name": "param",
@@ -2062,9 +2539,9 @@ export class SnkApplication {
2062
2539
  }, {
2063
2540
  "tags": [{
2064
2541
  "name": "param",
2065
- "text": "dataUnit - Instancia do Dataunit para ser armazenado em cache."
2542
+ "text": "dataUnit - Inst\u00E2ncia do Dataunit para ser armazenado em cache."
2066
2543
  }],
2067
- "text": "- Instancia do Dataunit para ser armazenado em cache."
2544
+ "text": "- Inst\u00E2ncia do Dataunit para ser armazenado em cache."
2068
2545
  }],
2069
2546
  "references": {
2070
2547
  "Promise": {
@@ -2081,13 +2558,19 @@ export class SnkApplication {
2081
2558
  "text": "Atualiza o cache de dataunits da aplica\u00E7\u00E3o.",
2082
2559
  "tags": [{
2083
2560
  "name": "param",
2084
- "text": "oldName - Nome do dataunit que est\u00E1 em cache."
2561
+ "text": "oldName - Nome do dataunit que est\u00E1 em cache (ser\u00E1 removido)."
2085
2562
  }, {
2086
2563
  "name": "param",
2087
2564
  "text": "dataUnitName - Nome do dataunit que ser\u00E1 armazenado em cache."
2088
2565
  }, {
2089
2566
  "name": "param",
2090
- "text": "dataUnit - Instancia do Dataunit para ser armazenado em cache."
2567
+ "text": "dataUnit - Inst\u00E2ncia do Dataunit para ser armazenado em cache."
2568
+ }, {
2569
+ "name": "returns",
2570
+ "text": undefined
2571
+ }, {
2572
+ "name": "async",
2573
+ "text": undefined
2091
2574
  }]
2092
2575
  }
2093
2576
  },
@@ -2095,20 +2578,35 @@ export class SnkApplication {
2095
2578
  "complexType": {
2096
2579
  "signature": "(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>",
2097
2580
  "parameters": [{
2098
- "tags": [],
2099
- "text": ""
2581
+ "tags": [{
2582
+ "name": "param",
2583
+ "text": "entityName - O nome da entidade."
2584
+ }],
2585
+ "text": "- O nome da entidade."
2100
2586
  }, {
2101
- "tags": [],
2102
- "text": ""
2587
+ "tags": [{
2588
+ "name": "param",
2589
+ "text": "dataUnitName - O nome para identificar o DataUnit no cache."
2590
+ }],
2591
+ "text": "- O nome para identificar o DataUnit no cache."
2103
2592
  }, {
2104
- "tags": [],
2105
- "text": ""
2593
+ "tags": [{
2594
+ "name": "param",
2595
+ "text": "parentDataUnit - O DataUnit pai, se houver."
2596
+ }],
2597
+ "text": "- O DataUnit pai, se houver."
2106
2598
  }, {
2107
- "tags": [],
2108
- "text": ""
2599
+ "tags": [{
2600
+ "name": "param",
2601
+ "text": "configName - O nome da configura\u00E7\u00E3o a ser usada."
2602
+ }],
2603
+ "text": "- O nome da configura\u00E7\u00E3o a ser usada."
2109
2604
  }, {
2110
- "tags": [],
2111
- "text": ""
2605
+ "tags": [{
2606
+ "name": "param",
2607
+ "text": "resourceID - O ID do recurso. Se n\u00E3o fornecido, usa o da aplica\u00E7\u00E3o."
2608
+ }],
2609
+ "text": "- O ID do recurso. Se n\u00E3o fornecido, usa o da aplica\u00E7\u00E3o."
2112
2610
  }],
2113
2611
  "references": {
2114
2612
  "Promise": {
@@ -2122,8 +2620,29 @@ export class SnkApplication {
2122
2620
  "return": "Promise<DataUnit>"
2123
2621
  },
2124
2622
  "docs": {
2125
- "text": "Obtem um DataUnit do cache ou cria um caso ainda n\u00E3o tenha sido criado.",
2126
- "tags": []
2623
+ "text": "Obt\u00E9m um DataUnit do cache ou cria um caso ainda n\u00E3o tenha sido criado.",
2624
+ "tags": [{
2625
+ "name": "param",
2626
+ "text": "entityName - O nome da entidade."
2627
+ }, {
2628
+ "name": "param",
2629
+ "text": "dataUnitName - O nome para identificar o DataUnit no cache."
2630
+ }, {
2631
+ "name": "param",
2632
+ "text": "parentDataUnit - O DataUnit pai, se houver."
2633
+ }, {
2634
+ "name": "param",
2635
+ "text": "configName - O nome da configura\u00E7\u00E3o a ser usada."
2636
+ }, {
2637
+ "name": "param",
2638
+ "text": "resourceID - O ID do recurso. Se n\u00E3o fornecido, usa o da aplica\u00E7\u00E3o."
2639
+ }, {
2640
+ "name": "returns",
2641
+ "text": "O DataUnit obtido do cache ou rec\u00E9m-criado."
2642
+ }, {
2643
+ "name": "async",
2644
+ "text": undefined
2645
+ }]
2127
2646
  }
2128
2647
  },
2129
2648
  "addClientEvent": {
@@ -2168,6 +2687,12 @@ export class SnkApplication {
2168
2687
  }, {
2169
2688
  "name": "param",
2170
2689
  "text": "handler - Fun\u00E7\u00E3o de callback que ser\u00E1 chamada quando o client event ocorrer."
2690
+ }, {
2691
+ "name": "returns",
2692
+ "text": undefined
2693
+ }, {
2694
+ "name": "async",
2695
+ "text": undefined
2171
2696
  }]
2172
2697
  }
2173
2698
  },
@@ -2192,10 +2717,16 @@ export class SnkApplication {
2192
2717
  "return": "Promise<void>"
2193
2718
  },
2194
2719
  "docs": {
2195
- "text": "Remove um client event para o DataFetcher da aplica\u00E7\u00E3o.",
2720
+ "text": "Remove um client event do DataFetcher da aplica\u00E7\u00E3o.",
2196
2721
  "tags": [{
2197
2722
  "name": "param",
2198
2723
  "text": "eventID - Nome do evento a ser removido."
2724
+ }, {
2725
+ "name": "returns",
2726
+ "text": undefined
2727
+ }, {
2728
+ "name": "async",
2729
+ "text": undefined
2199
2730
  }]
2200
2731
  }
2201
2732
  },
@@ -2220,10 +2751,16 @@ export class SnkApplication {
2220
2751
  "return": "Promise<boolean>"
2221
2752
  },
2222
2753
  "docs": {
2223
- "text": "Verfica se um client event est\u00E1 registrado no DataFetcher da aplica\u00E7\u00E3o.",
2754
+ "text": "Verifica se um client event est\u00E1 registrado no DataFetcher da aplica\u00E7\u00E3o.",
2224
2755
  "tags": [{
2225
2756
  "name": "param",
2226
2757
  "text": "eventID - Nome do evento a ser verificado."
2758
+ }, {
2759
+ "name": "returns",
2760
+ "text": "`true` se o evento estiver registrado, `false` caso contr\u00E1rio."
2761
+ }, {
2762
+ "name": "async",
2763
+ "text": undefined
2227
2764
  }]
2228
2765
  }
2229
2766
  },
@@ -2240,7 +2777,13 @@ export class SnkApplication {
2240
2777
  },
2241
2778
  "docs": {
2242
2779
  "text": "Obt\u00E9m o resourceID da tela em quest\u00E3o.",
2243
- "tags": []
2780
+ "tags": [{
2781
+ "name": "returns",
2782
+ "text": "O ID do recurso da aplica\u00E7\u00E3o."
2783
+ }, {
2784
+ "name": "async",
2785
+ "text": undefined
2786
+ }]
2244
2787
  }
2245
2788
  },
2246
2789
  "getUserID": {
@@ -2255,25 +2798,43 @@ export class SnkApplication {
2255
2798
  "return": "Promise<string>"
2256
2799
  },
2257
2800
  "docs": {
2258
- "text": "Obt\u00E9m o UserId da tela em quest\u00E3o.",
2259
- "tags": []
2801
+ "text": "Obt\u00E9m o UserId do usu\u00E1rio logado.",
2802
+ "tags": [{
2803
+ "name": "returns",
2804
+ "text": "O ID do usu\u00E1rio."
2805
+ }, {
2806
+ "name": "async",
2807
+ "text": undefined
2808
+ }]
2260
2809
  }
2261
2810
  },
2262
2811
  "alert": {
2263
2812
  "complexType": {
2264
2813
  "signature": "(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>",
2265
2814
  "parameters": [{
2266
- "tags": [],
2267
- "text": ""
2815
+ "tags": [{
2816
+ "name": "param",
2817
+ "text": "title - O t\u00EDtulo do alerta."
2818
+ }],
2819
+ "text": "- O t\u00EDtulo do alerta."
2268
2820
  }, {
2269
- "tags": [],
2270
- "text": ""
2821
+ "tags": [{
2822
+ "name": "param",
2823
+ "text": "message - A mensagem do alerta."
2824
+ }],
2825
+ "text": "- A mensagem do alerta."
2271
2826
  }, {
2272
- "tags": [],
2273
- "text": ""
2827
+ "tags": [{
2828
+ "name": "param",
2829
+ "text": "icon - O nome do \u00EDcone a ser exibido."
2830
+ }],
2831
+ "text": "- O nome do \u00EDcone a ser exibido."
2274
2832
  }, {
2275
- "tags": [],
2276
- "text": ""
2833
+ "tags": [{
2834
+ "name": "param",
2835
+ "text": "options - Op\u00E7\u00F5es adicionais para a mensagem."
2836
+ }],
2837
+ "text": "- Op\u00E7\u00F5es adicionais para a mensagem."
2277
2838
  }],
2278
2839
  "references": {
2279
2840
  "Promise": {
@@ -2288,24 +2849,54 @@ export class SnkApplication {
2288
2849
  },
2289
2850
  "docs": {
2290
2851
  "text": "Exibe o di\u00E1logo de alerta de acordo com os par\u00E2metros passados.",
2291
- "tags": []
2852
+ "tags": [{
2853
+ "name": "param",
2854
+ "text": "title - O t\u00EDtulo do alerta."
2855
+ }, {
2856
+ "name": "param",
2857
+ "text": "message - A mensagem do alerta."
2858
+ }, {
2859
+ "name": "param",
2860
+ "text": "icon - O nome do \u00EDcone a ser exibido."
2861
+ }, {
2862
+ "name": "param",
2863
+ "text": "options - Op\u00E7\u00F5es adicionais para a mensagem."
2864
+ }, {
2865
+ "name": "returns",
2866
+ "text": undefined
2867
+ }, {
2868
+ "name": "async",
2869
+ "text": undefined
2870
+ }]
2292
2871
  }
2293
2872
  },
2294
2873
  "error": {
2295
2874
  "complexType": {
2296
2875
  "signature": "(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>",
2297
2876
  "parameters": [{
2298
- "tags": [],
2299
- "text": ""
2877
+ "tags": [{
2878
+ "name": "param",
2879
+ "text": "title - O t\u00EDtulo do erro."
2880
+ }],
2881
+ "text": "- O t\u00EDtulo do erro."
2300
2882
  }, {
2301
- "tags": [],
2302
- "text": ""
2883
+ "tags": [{
2884
+ "name": "param",
2885
+ "text": "message - A mensagem do erro."
2886
+ }],
2887
+ "text": "- A mensagem do erro."
2303
2888
  }, {
2304
- "tags": [],
2305
- "text": ""
2889
+ "tags": [{
2890
+ "name": "param",
2891
+ "text": "icon - O nome do \u00EDcone a ser exibido."
2892
+ }],
2893
+ "text": "- O nome do \u00EDcone a ser exibido."
2306
2894
  }, {
2307
- "tags": [],
2308
- "text": ""
2895
+ "tags": [{
2896
+ "name": "param",
2897
+ "text": "options - Op\u00E7\u00F5es adicionais para a mensagem."
2898
+ }],
2899
+ "text": "- Op\u00E7\u00F5es adicionais para a mensagem."
2309
2900
  }],
2310
2901
  "references": {
2311
2902
  "Promise": {
@@ -2320,24 +2911,54 @@ export class SnkApplication {
2320
2911
  },
2321
2912
  "docs": {
2322
2913
  "text": "Exibe o di\u00E1logo de erro de acordo com os par\u00E2metros passados.",
2323
- "tags": []
2914
+ "tags": [{
2915
+ "name": "param",
2916
+ "text": "title - O t\u00EDtulo do erro."
2917
+ }, {
2918
+ "name": "param",
2919
+ "text": "message - A mensagem do erro."
2920
+ }, {
2921
+ "name": "param",
2922
+ "text": "icon - O nome do \u00EDcone a ser exibido."
2923
+ }, {
2924
+ "name": "param",
2925
+ "text": "options - Op\u00E7\u00F5es adicionais para a mensagem."
2926
+ }, {
2927
+ "name": "returns",
2928
+ "text": undefined
2929
+ }, {
2930
+ "name": "async",
2931
+ "text": undefined
2932
+ }]
2324
2933
  }
2325
2934
  },
2326
2935
  "success": {
2327
2936
  "complexType": {
2328
2937
  "signature": "(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>",
2329
2938
  "parameters": [{
2330
- "tags": [],
2331
- "text": ""
2939
+ "tags": [{
2940
+ "name": "param",
2941
+ "text": "title - O t\u00EDtulo da mensagem de sucesso."
2942
+ }],
2943
+ "text": "- O t\u00EDtulo da mensagem de sucesso."
2332
2944
  }, {
2333
- "tags": [],
2334
- "text": ""
2945
+ "tags": [{
2946
+ "name": "param",
2947
+ "text": "message - A mensagem de sucesso."
2948
+ }],
2949
+ "text": "- A mensagem de sucesso."
2335
2950
  }, {
2336
- "tags": [],
2337
- "text": ""
2951
+ "tags": [{
2952
+ "name": "param",
2953
+ "text": "icon - O nome do \u00EDcone a ser exibido."
2954
+ }],
2955
+ "text": "- O nome do \u00EDcone a ser exibido."
2338
2956
  }, {
2339
- "tags": [],
2340
- "text": ""
2957
+ "tags": [{
2958
+ "name": "param",
2959
+ "text": "options - Op\u00E7\u00F5es adicionais para a mensagem."
2960
+ }],
2961
+ "text": "- Op\u00E7\u00F5es adicionais para a mensagem."
2341
2962
  }],
2342
2963
  "references": {
2343
2964
  "Promise": {
@@ -2352,24 +2973,54 @@ export class SnkApplication {
2352
2973
  },
2353
2974
  "docs": {
2354
2975
  "text": "Exibe o di\u00E1logo de sucesso de acordo com os par\u00E2metros passados.",
2355
- "tags": []
2976
+ "tags": [{
2977
+ "name": "param",
2978
+ "text": "title - O t\u00EDtulo da mensagem de sucesso."
2979
+ }, {
2980
+ "name": "param",
2981
+ "text": "message - A mensagem de sucesso."
2982
+ }, {
2983
+ "name": "param",
2984
+ "text": "icon - O nome do \u00EDcone a ser exibido."
2985
+ }, {
2986
+ "name": "param",
2987
+ "text": "options - Op\u00E7\u00F5es adicionais para a mensagem."
2988
+ }, {
2989
+ "name": "returns",
2990
+ "text": undefined
2991
+ }, {
2992
+ "name": "async",
2993
+ "text": undefined
2994
+ }]
2356
2995
  }
2357
2996
  },
2358
2997
  "message": {
2359
2998
  "complexType": {
2360
2999
  "signature": "(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>",
2361
3000
  "parameters": [{
2362
- "tags": [],
2363
- "text": ""
3001
+ "tags": [{
3002
+ "name": "param",
3003
+ "text": "title - O t\u00EDtulo da mensagem."
3004
+ }],
3005
+ "text": "- O t\u00EDtulo da mensagem."
2364
3006
  }, {
2365
- "tags": [],
2366
- "text": ""
3007
+ "tags": [{
3008
+ "name": "param",
3009
+ "text": "message - A mensagem."
3010
+ }],
3011
+ "text": "- A mensagem."
2367
3012
  }, {
2368
- "tags": [],
2369
- "text": ""
3013
+ "tags": [{
3014
+ "name": "param",
3015
+ "text": "icon - O nome do \u00EDcone a ser exibido."
3016
+ }],
3017
+ "text": "- O nome do \u00EDcone a ser exibido."
2370
3018
  }, {
2371
- "tags": [],
2372
- "text": ""
3019
+ "tags": [{
3020
+ "name": "param",
3021
+ "text": "options - Op\u00E7\u00F5es adicionais para a mensagem."
3022
+ }],
3023
+ "text": "- Op\u00E7\u00F5es adicionais para a mensagem."
2373
3024
  }],
2374
3025
  "references": {
2375
3026
  "Promise": {
@@ -2383,28 +3034,61 @@ export class SnkApplication {
2383
3034
  "return": "Promise<boolean>"
2384
3035
  },
2385
3036
  "docs": {
2386
- "text": "Exibe um di\u00E1logo de mensagem comum",
2387
- "tags": []
3037
+ "text": "Exibe um di\u00E1logo de mensagem comum.",
3038
+ "tags": [{
3039
+ "name": "param",
3040
+ "text": "title - O t\u00EDtulo da mensagem."
3041
+ }, {
3042
+ "name": "param",
3043
+ "text": "message - A mensagem."
3044
+ }, {
3045
+ "name": "param",
3046
+ "text": "icon - O nome do \u00EDcone a ser exibido."
3047
+ }, {
3048
+ "name": "param",
3049
+ "text": "options - Op\u00E7\u00F5es adicionais para a mensagem."
3050
+ }, {
3051
+ "name": "returns",
3052
+ "text": undefined
3053
+ }, {
3054
+ "name": "async",
3055
+ "text": undefined
3056
+ }]
2388
3057
  }
2389
3058
  },
2390
3059
  "confirm": {
2391
3060
  "complexType": {
2392
3061
  "signature": "(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions) => Promise<boolean>",
2393
3062
  "parameters": [{
2394
- "tags": [],
2395
- "text": ""
3063
+ "tags": [{
3064
+ "name": "param",
3065
+ "text": "title - O t\u00EDtulo da confirma\u00E7\u00E3o."
3066
+ }],
3067
+ "text": "- O t\u00EDtulo da confirma\u00E7\u00E3o."
2396
3068
  }, {
2397
- "tags": [],
2398
- "text": ""
3069
+ "tags": [{
3070
+ "name": "param",
3071
+ "text": "message - A mensagem da confirma\u00E7\u00E3o."
3072
+ }],
3073
+ "text": "- A mensagem da confirma\u00E7\u00E3o."
2399
3074
  }, {
2400
- "tags": [],
2401
- "text": ""
3075
+ "tags": [{
3076
+ "name": "param",
3077
+ "text": "icon - O nome do \u00EDcone a ser exibido."
3078
+ }],
3079
+ "text": "- O nome do \u00EDcone a ser exibido."
2402
3080
  }, {
2403
- "tags": [],
2404
- "text": ""
3081
+ "tags": [{
3082
+ "name": "param",
3083
+ "text": "dialogType - O tipo de di\u00E1logo."
3084
+ }],
3085
+ "text": "- O tipo de di\u00E1logo."
2405
3086
  }, {
2406
- "tags": [],
2407
- "text": ""
3087
+ "tags": [{
3088
+ "name": "param",
3089
+ "text": "options - Op\u00E7\u00F5es adicionais para a mensagem."
3090
+ }],
3091
+ "text": "- Op\u00E7\u00F5es adicionais para a mensagem."
2408
3092
  }],
2409
3093
  "references": {
2410
3094
  "Promise": {
@@ -2422,19 +3106,46 @@ export class SnkApplication {
2422
3106
  "return": "Promise<boolean>"
2423
3107
  },
2424
3108
  "docs": {
2425
- "text": "Exibe um di\u00E1logo de confirma\u00E7\u00E3o",
2426
- "tags": []
3109
+ "text": "Exibe um di\u00E1logo de confirma\u00E7\u00E3o.",
3110
+ "tags": [{
3111
+ "name": "param",
3112
+ "text": "title - O t\u00EDtulo da confirma\u00E7\u00E3o."
3113
+ }, {
3114
+ "name": "param",
3115
+ "text": "message - A mensagem da confirma\u00E7\u00E3o."
3116
+ }, {
3117
+ "name": "param",
3118
+ "text": "icon - O nome do \u00EDcone a ser exibido."
3119
+ }, {
3120
+ "name": "param",
3121
+ "text": "dialogType - O tipo de di\u00E1logo."
3122
+ }, {
3123
+ "name": "param",
3124
+ "text": "options - Op\u00E7\u00F5es adicionais para a mensagem."
3125
+ }, {
3126
+ "name": "returns",
3127
+ "text": "`true` se confirmado, `false` caso contr\u00E1rio."
3128
+ }, {
3129
+ "name": "async",
3130
+ "text": undefined
3131
+ }]
2427
3132
  }
2428
3133
  },
2429
3134
  "info": {
2430
3135
  "complexType": {
2431
3136
  "signature": "(message: string, options?: MessageOptions) => Promise<void>",
2432
3137
  "parameters": [{
2433
- "tags": [],
2434
- "text": ""
3138
+ "tags": [{
3139
+ "name": "param",
3140
+ "text": "message - A mensagem a ser exibida."
3141
+ }],
3142
+ "text": "- A mensagem a ser exibida."
2435
3143
  }, {
2436
- "tags": [],
2437
- "text": ""
3144
+ "tags": [{
3145
+ "name": "param",
3146
+ "text": "options - Op\u00E7\u00F5es adicionais para a mensagem."
3147
+ }],
3148
+ "text": "- Op\u00E7\u00F5es adicionais para a mensagem."
2438
3149
  }],
2439
3150
  "references": {
2440
3151
  "Promise": {
@@ -2449,21 +3160,42 @@ export class SnkApplication {
2449
3160
  },
2450
3161
  "docs": {
2451
3162
  "text": "Exibe uma informa\u00E7\u00E3o ef\u00EAmera (de segundo plano).",
2452
- "tags": []
3163
+ "tags": [{
3164
+ "name": "param",
3165
+ "text": "message - A mensagem a ser exibida."
3166
+ }, {
3167
+ "name": "param",
3168
+ "text": "options - Op\u00E7\u00F5es adicionais para a mensagem."
3169
+ }, {
3170
+ "name": "returns",
3171
+ "text": undefined
3172
+ }, {
3173
+ "name": "async",
3174
+ "text": undefined
3175
+ }]
2453
3176
  }
2454
3177
  },
2455
3178
  "loadTotals": {
2456
3179
  "complexType": {
2457
3180
  "signature": "(name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>",
2458
3181
  "parameters": [{
2459
- "tags": [],
2460
- "text": ""
3182
+ "tags": [{
3183
+ "name": "param",
3184
+ "text": "name - O nome da configura\u00E7\u00E3o de totalizadores."
3185
+ }],
3186
+ "text": "- O nome da configura\u00E7\u00E3o de totalizadores."
2461
3187
  }, {
2462
- "tags": [],
2463
- "text": ""
3188
+ "tags": [{
3189
+ "name": "param",
3190
+ "text": "resourceID - O ID do recurso."
3191
+ }],
3192
+ "text": "- O ID do recurso."
2464
3193
  }, {
2465
- "tags": [],
2466
- "text": ""
3194
+ "tags": [{
3195
+ "name": "param",
3196
+ "text": "filters - A lista de filtros a serem aplicados."
3197
+ }],
3198
+ "text": "- A lista de filtros a serem aplicados."
2467
3199
  }],
2468
3200
  "references": {
2469
3201
  "Promise": {
@@ -2484,7 +3216,22 @@ export class SnkApplication {
2484
3216
  },
2485
3217
  "docs": {
2486
3218
  "text": "Obt\u00E9m os totalizadores da grade.",
2487
- "tags": []
3219
+ "tags": [{
3220
+ "name": "param",
3221
+ "text": "name - O nome da configura\u00E7\u00E3o de totalizadores."
3222
+ }, {
3223
+ "name": "param",
3224
+ "text": "resourceID - O ID do recurso."
3225
+ }, {
3226
+ "name": "param",
3227
+ "text": "filters - A lista de filtros a serem aplicados."
3228
+ }, {
3229
+ "name": "returns",
3230
+ "text": "Um mapa com os nomes dos totalizadores e seus valores."
3231
+ }, {
3232
+ "name": "async",
3233
+ "text": undefined
3234
+ }]
2488
3235
  }
2489
3236
  },
2490
3237
  "isLoadedByPk": {
@@ -2499,10 +3246,13 @@ export class SnkApplication {
2499
3246
  "return": "Promise<boolean>"
2500
3247
  },
2501
3248
  "docs": {
2502
- "text": "Obt\u00E9m a informa\u00E7\u00E3o se o \u00FAltimo carregamento do dataunit foi feito atrav\u00E9s de um loadByPk",
3249
+ "text": "Obt\u00E9m a informa\u00E7\u00E3o se o \u00FAltimo carregamento do dataunit foi feito atrav\u00E9s de um loadByPk.",
2503
3250
  "tags": [{
2504
3251
  "name": "returns",
2505
- "text": "boolean"
3252
+ "text": "`true` se foi carregado por PK, `false` caso contr\u00E1rio."
3253
+ }, {
3254
+ "name": "async",
3255
+ "text": undefined
2506
3256
  }]
2507
3257
  }
2508
3258
  },
@@ -2510,11 +3260,17 @@ export class SnkApplication {
2510
3260
  "complexType": {
2511
3261
  "signature": "(dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>",
2512
3262
  "parameters": [{
2513
- "tags": [],
2514
- "text": ""
3263
+ "tags": [{
3264
+ "name": "param",
3265
+ "text": "dataUnit - O DataUnit do qual o registro ser\u00E1 removido."
3266
+ }],
3267
+ "text": "- O DataUnit do qual o registro ser\u00E1 removido."
2515
3268
  }, {
2516
- "tags": [],
2517
- "text": ""
3269
+ "tags": [{
3270
+ "name": "param",
3271
+ "text": "recordsIDs - Os IDs dos registros a serem removidos."
3272
+ }],
3273
+ "text": "- Os IDs dos registros a serem removidos."
2518
3274
  }],
2519
3275
  "references": {
2520
3276
  "Promise": {
@@ -2532,24 +3288,48 @@ export class SnkApplication {
2532
3288
  },
2533
3289
  "docs": {
2534
3290
  "text": "Remove registro do cache do PreLoader do dataunit.\nDeve ser usado quando existe um dataunit usando loader do application, mas o removeLoader est\u00E1 sendo sobrescrito.",
2535
- "tags": []
3291
+ "tags": [{
3292
+ "name": "param",
3293
+ "text": "dataUnit - O DataUnit do qual o registro ser\u00E1 removido."
3294
+ }, {
3295
+ "name": "param",
3296
+ "text": "recordsIDs - Os IDs dos registros a serem removidos."
3297
+ }, {
3298
+ "name": "returns",
3299
+ "text": undefined
3300
+ }, {
3301
+ "name": "async",
3302
+ "text": undefined
3303
+ }]
2536
3304
  }
2537
3305
  },
2538
3306
  "executeSearch": {
2539
3307
  "complexType": {
2540
- "signature": "(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption> | IOption>",
3308
+ "signature": "(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption> | IOption>",
2541
3309
  "parameters": [{
2542
- "tags": [],
2543
- "text": ""
3310
+ "tags": [{
3311
+ "name": "param",
3312
+ "text": "searchArgument - Argumentos da pesquisa."
3313
+ }],
3314
+ "text": "- Argumentos da pesquisa."
2544
3315
  }, {
2545
- "tags": [],
2546
- "text": ""
3316
+ "tags": [{
3317
+ "name": "param",
3318
+ "text": "fieldName - Nome do campo no DataUnit."
3319
+ }],
3320
+ "text": "- Nome do campo no DataUnit."
2547
3321
  }, {
2548
- "tags": [],
2549
- "text": ""
3322
+ "tags": [{
3323
+ "name": "param",
3324
+ "text": "dataUnit - Inst\u00E2ncia do DataUnit."
3325
+ }],
3326
+ "text": "- Inst\u00E2ncia do DataUnit."
2550
3327
  }, {
2551
- "tags": [],
2552
- "text": ""
3328
+ "tags": [{
3329
+ "name": "param",
3330
+ "text": "ctxOptions - Op\u00E7\u00F5es de contexto adicionais."
3331
+ }],
3332
+ "text": "- Op\u00E7\u00F5es de contexto adicionais."
2553
3333
  }],
2554
3334
  "references": {
2555
3335
  "Promise": {
@@ -2567,6 +3347,9 @@ export class SnkApplication {
2567
3347
  "location": "import",
2568
3348
  "path": "@sankhyalabs/core"
2569
3349
  },
3350
+ "ISearchCtxOptions": {
3351
+ "location": "local"
3352
+ },
2570
3353
  "Array": {
2571
3354
  "location": "global"
2572
3355
  },
@@ -2578,8 +3361,26 @@ export class SnkApplication {
2578
3361
  "return": "Promise<IOption | IOption[]>"
2579
3362
  },
2580
3363
  "docs": {
2581
- "text": "Obt\u00E9m as op\u00E7\u00F5es em componentes de pesquisa\nEx.: snk-config-options",
2582
- "tags": []
3364
+ "text": "Obt\u00E9m as op\u00E7\u00F5es em componentes de pesquisa.\nEx.: snk-config-options",
3365
+ "tags": [{
3366
+ "name": "param",
3367
+ "text": "searchArgument - Argumentos da pesquisa."
3368
+ }, {
3369
+ "name": "param",
3370
+ "text": "fieldName - Nome do campo no DataUnit."
3371
+ }, {
3372
+ "name": "param",
3373
+ "text": "dataUnit - Inst\u00E2ncia do DataUnit."
3374
+ }, {
3375
+ "name": "param",
3376
+ "text": "ctxOptions - Op\u00E7\u00F5es de contexto adicionais."
3377
+ }, {
3378
+ "name": "returns",
3379
+ "text": "Uma lista de op\u00E7\u00F5es ou uma \u00FAnica op\u00E7\u00E3o."
3380
+ }, {
3381
+ "name": "async",
3382
+ "text": undefined
3383
+ }]
2583
3384
  }
2584
3385
  },
2585
3386
  "executePreparedSearchPlus": {
@@ -2618,14 +3419,23 @@ export class SnkApplication {
2618
3419
  "complexType": {
2619
3420
  "signature": "(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>",
2620
3421
  "parameters": [{
2621
- "tags": [],
2622
- "text": ""
3422
+ "tags": [{
3423
+ "name": "param",
3424
+ "text": "mode - O modo da pesquisa (\"ADVANCED\" ou outro)."
3425
+ }],
3426
+ "text": "- O modo da pesquisa (\"ADVANCED\" ou outro)."
2623
3427
  }, {
2624
- "tags": [],
2625
- "text": ""
3428
+ "tags": [{
3429
+ "name": "param",
3430
+ "text": "argument - O argumento da pesquisa."
3431
+ }],
3432
+ "text": "- O argumento da pesquisa."
2626
3433
  }, {
2627
- "tags": [],
2628
- "text": ""
3434
+ "tags": [{
3435
+ "name": "param",
3436
+ "text": "options - Op\u00E7\u00F5es preparadas para a pesquisa. Veja a documenta\u00E7\u00E3o para exemplo de uso."
3437
+ }],
3438
+ "text": "- Op\u00E7\u00F5es preparadas para a pesquisa. Veja a documenta\u00E7\u00E3o para exemplo de uso."
2629
3439
  }],
2630
3440
  "references": {
2631
3441
  "Promise": {
@@ -2645,8 +3455,23 @@ export class SnkApplication {
2645
3455
  "return": "Promise<IOption | IOption[]>"
2646
3456
  },
2647
3457
  "docs": {
2648
- "text": "Obt\u00E9m as op\u00E7\u00F5es em componentes de pesquisa\nEx.: snk-config-options",
2649
- "tags": []
3458
+ "text": "",
3459
+ "tags": [{
3460
+ "name": "param",
3461
+ "text": "mode - O modo da pesquisa (\"ADVANCED\" ou outro)."
3462
+ }, {
3463
+ "name": "param",
3464
+ "text": "argument - O argumento da pesquisa."
3465
+ }, {
3466
+ "name": "param",
3467
+ "text": "options - Op\u00E7\u00F5es preparadas para a pesquisa. Veja a documenta\u00E7\u00E3o para exemplo de uso."
3468
+ }, {
3469
+ "name": "returns",
3470
+ "text": "Uma lista de op\u00E7\u00F5es ou uma \u00FAnica op\u00E7\u00E3o."
3471
+ }, {
3472
+ "name": "async",
3473
+ "text": undefined
3474
+ }]
2650
3475
  }
2651
3476
  },
2652
3477
  "isDebugMode": {
@@ -2677,22 +3502,37 @@ export class SnkApplication {
2677
3502
  "return": "Promise<string>"
2678
3503
  },
2679
3504
  "docs": {
2680
- "text": "Obt\u00E9m o nome das telas da aplica\u00E7\u00E3o",
2681
- "tags": []
3505
+ "text": "Obt\u00E9m o nome (label) da aplica\u00E7\u00E3o.",
3506
+ "tags": [{
3507
+ "name": "returns",
3508
+ "text": "O nome da aplica\u00E7\u00E3o."
3509
+ }, {
3510
+ "name": "async",
3511
+ "text": undefined
3512
+ }]
2682
3513
  }
2683
3514
  },
2684
3515
  "addSearchListener": {
2685
3516
  "complexType": {
2686
3517
  "signature": "(entityName: string, dataUnit: DataUnit, listener: ISearchListener) => Promise<IRemoveSearchListener>",
2687
3518
  "parameters": [{
2688
- "tags": [],
2689
- "text": ""
3519
+ "tags": [{
3520
+ "name": "param",
3521
+ "text": "entityName - O nome da entidade."
3522
+ }],
3523
+ "text": "- O nome da entidade."
2690
3524
  }, {
2691
- "tags": [],
2692
- "text": ""
3525
+ "tags": [{
3526
+ "name": "param",
3527
+ "text": "dataUnit - A inst\u00E2ncia do DataUnit."
3528
+ }],
3529
+ "text": "- A inst\u00E2ncia do DataUnit."
2693
3530
  }, {
2694
- "tags": [],
2695
- "text": ""
3531
+ "tags": [{
3532
+ "name": "param",
3533
+ "text": "listener - O listener a ser adicionado."
3534
+ }],
3535
+ "text": "- O listener a ser adicionado."
2696
3536
  }],
2697
3537
  "references": {
2698
3538
  "Promise": {
@@ -2714,8 +3554,23 @@ export class SnkApplication {
2714
3554
  "return": "Promise<IRemoveSearchListener>"
2715
3555
  },
2716
3556
  "docs": {
2717
- "text": "Adiciona um listener no fetcher de Pesquisa",
2718
- "tags": []
3557
+ "text": "Adiciona um listener no fetcher de Pesquisa.",
3558
+ "tags": [{
3559
+ "name": "param",
3560
+ "text": "entityName - O nome da entidade."
3561
+ }, {
3562
+ "name": "param",
3563
+ "text": "dataUnit - A inst\u00E2ncia do DataUnit."
3564
+ }, {
3565
+ "name": "param",
3566
+ "text": "listener - O listener a ser adicionado."
3567
+ }, {
3568
+ "name": "returns",
3569
+ "text": "Uma fun\u00E7\u00E3o para remover o listener."
3570
+ }, {
3571
+ "name": "async",
3572
+ "text": undefined
3573
+ }]
2719
3574
  }
2720
3575
  },
2721
3576
  "importScript": {
@@ -2724,9 +3579,9 @@ export class SnkApplication {
2724
3579
  "parameters": [{
2725
3580
  "tags": [{
2726
3581
  "name": "param",
2727
- "text": "relativePath : Define o caminho relativo para o arquivo JavaScript a ser importado."
3582
+ "text": "relativePath - Define o caminho relativo para o arquivo JavaScript a ser importado, ou uma lista de caminhos."
2728
3583
  }],
2729
- "text": ": Define o caminho relativo para o arquivo JavaScript a ser importado."
3584
+ "text": "- Define o caminho relativo para o arquivo JavaScript a ser importado, ou uma lista de caminhos."
2730
3585
  }],
2731
3586
  "references": {
2732
3587
  "Promise": {
@@ -2739,10 +3594,16 @@ export class SnkApplication {
2739
3594
  "return": "Promise<void>"
2740
3595
  },
2741
3596
  "docs": {
2742
- "text": "Realiza o import de um JavaScript que est\u00E1 disponivel dentro da pasta /public da aplica\u00E7\u00E3o.",
3597
+ "text": "Realiza o import de um JavaScript que est\u00E1 dispon\u00EDvel dentro da pasta /public da aplica\u00E7\u00E3o.",
2743
3598
  "tags": [{
2744
3599
  "name": "param",
2745
- "text": "relativePath : Define o caminho relativo para o arquivo JavaScript a ser importado."
3600
+ "text": "relativePath - Define o caminho relativo para o arquivo JavaScript a ser importado, ou uma lista de caminhos."
3601
+ }, {
3602
+ "name": "returns",
3603
+ "text": undefined
3604
+ }, {
3605
+ "name": "async",
3606
+ "text": undefined
2746
3607
  }]
2747
3608
  }
2748
3609
  },
@@ -2759,21 +3620,36 @@ export class SnkApplication {
2759
3620
  },
2760
3621
  "docs": {
2761
3622
  "text": "Retorna o path relativo da aplica\u00E7\u00E3o.",
2762
- "tags": []
3623
+ "tags": [{
3624
+ "name": "returns",
3625
+ "text": "O caminho relativo da aplica\u00E7\u00E3o."
3626
+ }, {
3627
+ "name": "async",
3628
+ "text": undefined
3629
+ }]
2763
3630
  }
2764
3631
  },
2765
3632
  "executeSelectDistinct": {
2766
3633
  "complexType": {
2767
3634
  "signature": "(dataUnit: DataUnit, fieldName: string, argument: string) => Promise<Array<any>>",
2768
3635
  "parameters": [{
2769
- "tags": [],
2770
- "text": ""
3636
+ "tags": [{
3637
+ "name": "param",
3638
+ "text": "dataUnit - A inst\u00E2ncia do DataUnit."
3639
+ }],
3640
+ "text": "- A inst\u00E2ncia do DataUnit."
2771
3641
  }, {
2772
- "tags": [],
2773
- "text": ""
3642
+ "tags": [{
3643
+ "name": "param",
3644
+ "text": "fieldName - O nome do campo para o select distinct."
3645
+ }],
3646
+ "text": "- O nome do campo para o select distinct."
2774
3647
  }, {
2775
- "tags": [],
2776
- "text": ""
3648
+ "tags": [{
3649
+ "name": "param",
3650
+ "text": "argument - O argumento de filtro para a coluna."
3651
+ }],
3652
+ "text": "- O argumento de filtro para a coluna."
2777
3653
  }],
2778
3654
  "references": {
2779
3655
  "Promise": {
@@ -2791,7 +3667,22 @@ export class SnkApplication {
2791
3667
  },
2792
3668
  "docs": {
2793
3669
  "text": "Com base em um campo realiza um \"select distinct\" respeitando os\nfiltros atuais do dataUnit e um crit\u00E9rio de filtro para a pr\u00F3pria\ncoluna.",
2794
- "tags": []
3670
+ "tags": [{
3671
+ "name": "param",
3672
+ "text": "dataUnit - A inst\u00E2ncia do DataUnit."
3673
+ }, {
3674
+ "name": "param",
3675
+ "text": "fieldName - O nome do campo para o select distinct."
3676
+ }, {
3677
+ "name": "param",
3678
+ "text": "argument - O argumento de filtro para a coluna."
3679
+ }, {
3680
+ "name": "returns",
3681
+ "text": "Uma lista de valores distintos."
3682
+ }, {
3683
+ "name": "async",
3684
+ "text": undefined
3685
+ }]
2795
3686
  }
2796
3687
  },
2797
3688
  "getDataFetcher": {
@@ -2810,10 +3701,13 @@ export class SnkApplication {
2810
3701
  "return": "Promise<DataFetcher>"
2811
3702
  },
2812
3703
  "docs": {
2813
- "text": "Retorna a instancia do DataFetcher utilizado pelo application",
3704
+ "text": "Retorna a inst\u00E2ncia do DataFetcher utilizado pelo application.",
2814
3705
  "tags": [{
2815
3706
  "name": "returns",
2816
- "text": "DataFetcher do application"
3707
+ "text": "O DataFetcher da aplica\u00E7\u00E3o."
3708
+ }, {
3709
+ "name": "async",
3710
+ "text": undefined
2817
3711
  }]
2818
3712
  }
2819
3713
  },
@@ -2832,10 +3726,13 @@ export class SnkApplication {
2832
3726
  "return": "Promise<SnkApplication>"
2833
3727
  },
2834
3728
  "docs": {
2835
- "text": "Retorna uma promise que sera resolvida quando o snk-application estiver carregado e registrado no ApplicationContext",
3729
+ "text": "Retorna uma promise que ser\u00E1 resolvida quando o snk-application estiver carregado e registrado no ApplicationContext.",
2836
3730
  "tags": [{
2837
3731
  "name": "returns",
2838
- "text": "SnkApplication carregado."
3732
+ "text": "O componente SnkApplication carregado."
3733
+ }, {
3734
+ "name": "async",
3735
+ "text": undefined
2839
3736
  }]
2840
3737
  }
2841
3738
  },
@@ -2845,15 +3742,15 @@ export class SnkApplication {
2845
3742
  "parameters": [{
2846
3743
  "tags": [{
2847
3744
  "name": "param",
2848
- "text": "name - Nome do par\u00E2metro"
3745
+ "text": "name - Nome do par\u00E2metro."
2849
3746
  }],
2850
- "text": "- Nome do par\u00E2metro"
3747
+ "text": "- Nome do par\u00E2metro."
2851
3748
  }, {
2852
3749
  "tags": [{
2853
3750
  "name": "param",
2854
- "text": "value - String convers\u00EDvel de acordo com o tipo do par\u00E2metro"
3751
+ "text": "value - String convers\u00EDvel de acordo com o tipo do par\u00E2metro."
2855
3752
  }],
2856
- "text": "- String convers\u00EDvel de acordo com o tipo do par\u00E2metro"
3753
+ "text": "- String convers\u00EDvel de acordo com o tipo do par\u00E2metro."
2857
3754
  }],
2858
3755
  "references": {
2859
3756
  "Promise": {
@@ -2866,10 +3763,16 @@ export class SnkApplication {
2866
3763
  "text": "Atribui valor para par\u00E2metros de contexto no componente de pesquisa.",
2867
3764
  "tags": [{
2868
3765
  "name": "param",
2869
- "text": "name - Nome do par\u00E2metro"
3766
+ "text": "name - Nome do par\u00E2metro."
2870
3767
  }, {
2871
3768
  "name": "param",
2872
- "text": "value - String convers\u00EDvel de acordo com o tipo do par\u00E2metro"
3769
+ "text": "value - String convers\u00EDvel de acordo com o tipo do par\u00E2metro."
3770
+ }, {
3771
+ "name": "returns",
3772
+ "text": undefined
3773
+ }, {
3774
+ "name": "async",
3775
+ "text": undefined
2873
3776
  }]
2874
3777
  }
2875
3778
  },
@@ -2931,8 +3834,11 @@ export class SnkApplication {
2931
3834
  "complexType": {
2932
3835
  "signature": "(templateSkeletonType?: TEMPLATES_SKELETON) => Promise<void>",
2933
3836
  "parameters": [{
2934
- "tags": [],
2935
- "text": ""
3837
+ "tags": [{
3838
+ "name": "param",
3839
+ "text": "templateSkeletonType - O tipo de esqueleto de carregamento a ser exibido."
3840
+ }],
3841
+ "text": "- O tipo de esqueleto de carregamento a ser exibido."
2936
3842
  }],
2937
3843
  "references": {
2938
3844
  "Promise": {
@@ -2946,19 +3852,34 @@ export class SnkApplication {
2946
3852
  "return": "Promise<void>"
2947
3853
  },
2948
3854
  "docs": {
2949
- "text": "",
2950
- "tags": []
3855
+ "text": "Marca a aplica\u00E7\u00E3o para recarregar, opcionalmente especificando um tipo de esqueleto de carregamento.",
3856
+ "tags": [{
3857
+ "name": "param",
3858
+ "text": "templateSkeletonType - O tipo de esqueleto de carregamento a ser exibido."
3859
+ }, {
3860
+ "name": "returns",
3861
+ "text": undefined
3862
+ }, {
3863
+ "name": "async",
3864
+ "text": undefined
3865
+ }]
2951
3866
  }
2952
3867
  },
2953
3868
  "addLoadingLock": {
2954
3869
  "complexType": {
2955
3870
  "signature": "(forceReady?: boolean, templateSkeletonType?: TEMPLATES_SKELETON) => Promise<() => void>",
2956
3871
  "parameters": [{
2957
- "tags": [],
2958
- "text": ""
3872
+ "tags": [{
3873
+ "name": "param",
3874
+ "text": "forceReady - Se `true`, for\u00E7a a aplica\u00E7\u00E3o para o estado \"n\u00E3o pronto\" antes de adicionar o bloqueio."
3875
+ }],
3876
+ "text": "- Se `true`, for\u00E7a a aplica\u00E7\u00E3o para o estado \"n\u00E3o pronto\" antes de adicionar o bloqueio."
2959
3877
  }, {
2960
- "tags": [],
2961
- "text": ""
3878
+ "tags": [{
3879
+ "name": "param",
3880
+ "text": "templateSkeletonType - O tipo de esqueleto de carregamento a ser exibido."
3881
+ }],
3882
+ "text": "- O tipo de esqueleto de carregamento a ser exibido."
2962
3883
  }],
2963
3884
  "references": {
2964
3885
  "Promise": {
@@ -2972,8 +3893,20 @@ export class SnkApplication {
2972
3893
  "return": "Promise<() => void>"
2973
3894
  },
2974
3895
  "docs": {
2975
- "text": "",
2976
- "tags": []
3896
+ "text": "Adiciona um bloqueio de carregamento \u00E0 aplica\u00E7\u00E3o.",
3897
+ "tags": [{
3898
+ "name": "param",
3899
+ "text": "forceReady - Se `true`, for\u00E7a a aplica\u00E7\u00E3o para o estado \"n\u00E3o pronto\" antes de adicionar o bloqueio."
3900
+ }, {
3901
+ "name": "param",
3902
+ "text": "templateSkeletonType - O tipo de esqueleto de carregamento a ser exibido."
3903
+ }, {
3904
+ "name": "returns",
3905
+ "text": "O ID do bloqueio adicionado."
3906
+ }, {
3907
+ "name": "async",
3908
+ "text": undefined
3909
+ }]
2977
3910
  }
2978
3911
  }
2979
3912
  };