-
Notifications
You must be signed in to change notification settings - Fork 5
/
fluig.d.ts
6876 lines (5765 loc) · 193 KB
/
fluig.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
declare namespace com.totvs.technology.foundation.sdk.service.vo.common {
declare class OrderParam {}
declare class ResponseEnvelopeVO<T> {
getItems(): java.util.ArrayList<T>;
setItems(items: java.util.ArrayList<T>);
isHasNext(): boolean;
setHasNext(hasNext: boolean);
getTotal(): number;
setTotal(total: number);
}
}
/**
* Tipos de campo de um Dataset
*
* Usado na criação do Dataset, na função defineStructure.
*/
enum DatasetFieldType {
NUMBER,
STRING,
TEXT,
DATE,
BOOLEAN,
}
/**
* Cria uma coluna no dataset sincronizado
*/
declare function addColumn(coluna: string, tipo?: DatasetFieldType);
/**
* Cria a chave principal do dataset sincronizado
*
* Para uso dos métodos updateRecord, deleteRecord e addOrUpdate do dataset sincronizado.
*/
declare function setKey(chaves: string[]): void;
/**
* Cria um ou mais índices para maior performance na consulta do dataset sincronizado
*/
declare function addIndex(indices: string[]): void;
/**
* Tipos de Filtros (constraint)
*
* Usado para criar os filtros que serão repassados ao método getDataset.
* Usar nos eventos do Fluig ou na criação de Dataset customizado.
*/
enum ConstraintType {
/**
* Filtro: Deve Conter
*
* Interprete como o E lógico
*/
MUST,
/**
* Filtro: Pode Conter
*
* Interprete como OU lógico
*/
SHOULD,
/**
* Filtro: Não Deve Conter
*/
MUST_NOT,
}
declare class Dataset {
const rowsCount: number;
/**
* Retorna o valor de uma coluna (campo) em determinada linha (índice)
*/
getValue(linha: number, coluna: string): string;
/**
* Cria uma coluna no Dataset
*
* @example
* var dataset = DatasetBuilder().newDataset();
* dataset.addColumn("coluna1");
* dataset.addColumn("coluna2");
* dataset.addRow(["valor coluna 1", "valor coluna 2"]);
*/
addColumn(coluna: string): void;
/**
* Adicionar uma linha ao Dataset
*
* @example
* var dataset = DatasetBuilder().newDataset();
* dataset.addColumn("coluna1");
* dataset.addColumn("coluna2");
* dataset.addRow(["valor coluna 1", "valor coluna 2"]);
*/
addRow(valores: string[]|object[]): void;
/**
* Adiciona uma linha à coleção que será persistida no cache de sincronização.
*
* Através dos campos da chave principal do Dataset (setKey) os registros
* serão localizados e alterados conforme os dados enviados pela função.
*
* Esta função só funciona se implementado na função onSync.
*
* @example
* var dataset = DatasetBuilder.newDataset();
* dataset.addColumn("Coluna1");
* dataset.addColumn("Coluna2");
* dataset.updateRow(["Valor coluna 1", "Valor coluna 2"]);
*/
updateRow(valores: string[]|object[]): void;
/**
* Adiciona uma linha à coleção que será persistida no cache de sincronização.
*
* Caso o registro não exista ele será criado na base, caso contrário será atualizado.
*
* Através dos campos da chave principal do Dataset (setKey) os registros
* serão localizados e alterados conforme os dados enviados pela função.
*
* Esta função só funciona se implementado na função onSync.
*
* @example
* var dataset = DatasetBuilder.newDataset();
* dataset.addColumn("Coluna1");
* dataset.addColumn("Coluna2");
* dataset.addOrUpdateRow(["Valor coluna 1", "Valor coluna 2"]);
*/
addOrUpdateRow(valores: string[]|object[]): void;
/**
* Adiciona uma linha à coleção que eliminará esses registros no cache de sincronização.
*
* Através dos campos da chave principal do Dataset (setKey) os registros
* serão localizados e alterados conforme os dados enviados pela função.
*
* Esta função só funciona se implementado na função onSync.
*
* @example
* var dataset = DatasetBuilder.newDataset();
* dataset.addColumn("Coluna1");
* dataset.addColumn("Coluna2");
* dataset.deleteRow(["Valor coluna 1", "Valor coluna 2"]);
*/
deleteRow(valores: string[]|object[]): void;
}
/**
* Resultado de uma consulta ao Dataset usando o WCM
*
* Disponível somente nas páginas que usam o arquivo /webdesk/vcXMLRPC.js.
*/
interface DatasetWcmResult {
/**
* O nome das colunas
*/
columns: string[];
/**
* As propriedades do objeto são os nomes das colunas
*/
values: object[];
}
/**
* Indicativo das restrições ao sincronizar dados em Mobile
*/
interface DatasetMobileSync {
/**
* As colunas (em letras maiúsculas) a serem salvas no Mobile
*/
fields: string[];
/**
* Os filtros adicionais
*/
constraints: Constraint[];
/**
* Campos da ordenação
*/
sortFields: string[];
}
/**
* Formato de Callback para consulta assíncrona ao Dataset usando o WCM
*
* Disponível somente nas páginas que usam o arquivo /webdesk/vcXMLRPC.js.
*/
interface DatasetWcmCallback {
/**
* Função que será executada em caso de sucesso
*/
success: function (DatasetWcmResult);
/**
* Função que será executada em caso de falha
*
* @param jqXHR Objeto da JQuery
* @param textStatus
* @param errorThrown
*/
error: function (object, string, string): void;
}
declare class Constraint {
fieldName: string;
initialValue: string;
finalValue: string;
constraintType: ConstraintType;
/**
* Indica que a constraint fará uma busca usando LIKE ao invés de =
*/
setLikeSearch(likeSearch: boolean): void;
getFieldName(): string;
getInitialValue(): string;
getFinalValue(): string;
}
/**
* Funções para manipulação de Dataset
*/
declare namespace DatasetFactory {
/**
* Retorna o nome dos datasets disponíveis
*
* Para usar no HTML de formulário o arquivo vcXMLRPC.js precisa ser declarado: <script src="/webdesk/vcXMLRPC.js"></script>
*/
declare function getAvailableDatasets(): string[];
/**
* Cria uma constraint para ser usada no método getDataset
*
* Para usar no HTML de formulário o arquivo vcXMLRPC.js precisa ser declarado: <script src="/webdesk/vcXMLRPC.js"></script>
* Para fazer uma pesquisa usando LIKE pelo formulário deve-se passar true no parâmetro searchLike ao invés de usar o método
* setLikeSearch do objeto Constraint.
*/
declare function createConstraint(fieldName: string, initialValue: string, finalValue: string, constraintType: ConstraintType): Constraint;
declare function createConstraint(fieldName: string, initialValue: string, finalValue: string, constraintType: ConstraintType, searchLike: boolean): Constraint;
/**
* Pesquisa os dados de um dataset
*
* Para usar no HTML de formulário o arquivo vcXMLRPC.js precisa ser declarado: <script src="/webdesk/vcXMLRPC.js"></script>
*
* @param nomeDataset O nome do Dataset.
* @param campos Os campos que serão retornados.
* @param constraints Os filtros aplicados ao dataset.
* @param ordem Os campos que farão a ordenação do resultado. Pode-se acrescentar ;desc ao nome do campo para ordenar de forma decrescente.
*
* @example
* var constraints = [
* DatasetFactory.createConstraint("colleaguePK.colleagueId", "adm", "adm", ConstraintType.MUST_NOT),
* DatasetFactory.createConstraint("valor", "100", "999", ConstraintType.MUST)
* ];
* var dataset = DatasetFactory.getDataset("colleague", ["colleagueName"], constraints);
*/
declare function getDataset(nomeDataset: string, campos?: string[], constraints?: Constraint[], ordem?: string[]): Dataset;
/**
* Pesquisa os dados de um dataset de forma assíncrona
*
* Disponível somente nas páginas que usam o arquivo /webdesk/vcXMLRPC.js.
*
* @example
* var constraints = [
* DatasetFactory.createConstraint("colleaguePK.colleagueId", "adm", "adm", ConstraintType.MUST_NOT),
* DatasetFactory.createConstraint("valor", "100", "999", ConstraintType.MUST)
* ];
* var dataset = DatasetFactory.getDataset("colleague", ["colleagueName"], constraints);
*/
declare function getDataset(nomeDataset: string, campos?: string[], constraints?: Constraint[], ordem?: string[], callback: DatasetWcmCallback): void;
}
/**
* Funções para criação de Dataset
*/
declare namespace DatasetBuilder {
/**
* Cria um Dataset
*
* Usar somente ao criar datasets customizados.
*/
declare function newDataset(): Dataset;
}
/**
* Tipos de Documento
*
* Esse enum não existe no Fluig e foi criado somente para
* facilitar a identificação dos tipos de documento.
*
* No Fluig utilize somente os valores ao fazer as comparações.
*/
enum DocumentTypeEnum {
PASTA_RAIZ = '0',
PASTA = '1',
DOCUMENTO_NORMAL = '2',
DOCUMENTO_EXTERNO = '3',
FORMULARIO = '4',
FICHA = '5',
ANEXO_WORKFLOW = '7',
NOVO_CONTEUDO = '8',
APLICATIVO = '9',
RELATORIO = '10',
PASTA_SOCIAL = '15',
SITE = 'portal',
PAGINA_DE_SITE = 'portalPage',
}
/**
* Entidade Documento Relacionado
*/
declare class RelatedDocumentDto {
/**
* Retorna o número do documento
*
* Usar em eventos do Fluig.
*/
getDocumentId(): number;
/**
* Retorna o número do documento relacionado
*
* Usar em eventos do Fluig.
*/
getRelatedDocumentId(): number;
/**
* Retorna a versão do documento
*
* Usar em eventos do Fluig.
*/
getVersion(): number;
/**
* Retorna o código da empresa em que o documento foi publicado
*
* Usar em eventos do Fluig.
*/
getCompanyId(): number;
}
/**
* Funções relacionadas a Documentos
*
* Usar em qualquer evento.
*/
declare namespace docAPI {
/**
* Copia os arquivos físicos de um documento existente para a área de upload do usuário logado
* @returns Nomes dos arquivos que foram disponibilizados na área de upload
*/
declare function copyDocumentToUploadArea(documentId: number, version: number): string[];
}
/**
* Entidade Aprovador
*/
declare class ApproverDto {
/**
* Retorna o número do documento
*/
getDocumentId(): number;
/**
* Pega o número do aprovador
*/
getapproverId(): number;
/**
* Pega a versão do aprovador
*/
getVersion(): number;
/**
* Pega o código da empresa na qual o aprovador foi publicado
*/
getCompanyId(): number;
/**
* Pega a matrícula do colaborador que criou o aprovador
*/
getColleagueId(): number;
/**
* Pega o tipo de aprovação Pode ser 0 para Colaborador ou 1 para Grupo
*/
getApproverType(): number;
/**
* Pega o nível de aprovação no caso de aprovação em níveis
*/
getLevelId(): number;
}
/**
* Entidade Documento para usar nos Eventos
*/
declare class DocumentDto {
/**
* Pega o número do documento
*/
getDocumentId(): number;
/**
* Pega a versão do documento
*/
getVersion(): number;
/**
* Pega o código da empresa em que o documento foi publicado
*/
getCompanyId(): number;
/**
* Pega o UUID do documento
*/
getUUID(): string;
/**
* Pega o tipo do arquivo físico. Se retornar em branco ou nulo é um tipo desconhecido
*/
getDocumentTypeId(): string;
/**
* Pega o código do idioma do documento
*/
getLanguageId(): string;
/**
* Pega o código do ícone do documento
*/
getIconId(): number;
/**
* Pega o código do assunto do documento
*/
getTopicId(): number;
/**
* Pega a matrícula do colaborador que criou o documento
*/
getColleagueId(): string;
/**
* Pega a descrição do documento
*/
getDocumentDescription(): string;
/**
* Pega os comentários adicionais do documento
*/
getAdditionalComments(): string;
/**
* Pega o caminho físico do documento
*/
getPhisicalFile(): string;
/**
* Pega a data de criação do documento
*/
getCreateDate(): Date;
/**
* Pega a data de aprovação do documento
*/
getApprovedDate(): Date;
/**
* Pega a data da última modificação do documento
*/
getLastModifiedDate(): Date;
/**
* Pega a data da última modificação do documento
*/
getExpirationDate(): Date;
/**
* Pega o tipo do documento
*/
getDocumentType(): DocumentTypeEnum;
/**
* Pega o número da pasta/formulário pai
*/
getParentDocumentId(): number;
/**
* Pega o nome do arquivo físico principal e anexos
*/
getRelatedFiles(): number;
/**
* Verifica se o documento está ativo
*/
getActiveVersion(): boolean;
/**
* Pega a descrição da versão
*/
getVersionDescription(): string;
/**
* Verifica se o documento permite download
*/
getDownloadEnabled(): boolean;
/**
* Verifica se o documento está em aprovação
*/
getApproved(): boolean;
/**
* Pega a data a partir que o documento poderá ser visualizado
*/
getValidationStartDate(): Date
/**
* Pega a matrícula do colaborador que publicou o documento
*/
getPublisherId(): string;
/**
* Pega a descrição da ficha para documento do tipo 5
*/
getCardDescription(): string;
/**
* Pega o formulário que foi usado como base para criação da ficha.
*
* Utilizado somente com documento do tipo 5.
*/
getDocumentPropertyNumber(): number;
/**
* Pega a versão do formulário em que a ficha foi criada
*/
getDocumentPropertyVersion(): number;
/**
* Pega o código da empresa em que o documento foi publicado
*/
getCompanyId(): number;
/**
* Verifica se o documento/pasta está abaixo de pasta particular
*/
getPrivateDocument(): boolean;
/**
* Pega a matrícula do colaborador onde o documento particular está alocado
*/
getPrivateColleagueId(): string;
/**
* Verifica se o arquivo foi indexado
*/
getIndexed(): boolean;
/**
* Pega a prioridade do documento
*/
getPriority(): number;
/**
* Verifica se notifica os usuários que tenham esse assunto de interesse
*/
getUserNotify(): boolean;
/**
* Verifica se o documento está expirado
*/
getExpires(): boolean;
/**
* Pega o volume onde o documento foi publicado. Se estiver em branco foi no volume pai.
*/
getVolumeId(): string;
/**
* Verifica se herda segurança do pai
*/
getInheritSecurity(): boolean;
/**
* Verifica se atualiza as propriedades da cópia controlada
*/
getUpdateIsoProperties(): boolean;
/**
* Pega a hora da última modificação em milissegundos
*/
getLastModifiedTime(): string;
/**
* Verifica se o documento está na lixeira
*/
getDeleted(): boolean;
/**
* Pega o documento do dataset se o documento é um formulário
*/
getDatasetName(): string;
/**
* Pega as palavras-chave do documento. Cada palavra é separada por vírgula.
*/
getKeyWord(): string;
/**
* Verifica se a versão/revisão é inalterável
*/
getImutable(): boolean;
/**
* Verifica se o documento está em edição, para documento do tipo "Novo Conteúdo"
*/
getDraft(): boolean;
/**
* Verifica se utiliza visualizador interno
*/
getInternalVisualizer(): boolean;
/**
* Pega o tamanho físico do documento principal e anexos
*/
getPhisicalFileSize(): number;
};
/**
* Representa as propriedades editáveis de um documento
*/
declare class DocumentEditDto {
/**
* Adiciona Palavras chaves no documento
*
* Cada palavra é separada por vírgula.
*/
setKeyWord(keyWord: string): void;
/**
* Define se o documento deve expirar
*/
setExpires(expires: boolean): void;
/**
* Define a data de expiração
*/
setExpirationDate(expireAt: java.util.Date): void;
/**
* Define a data a partir da qual o documento poderá ser visualizado
*/
setValidationStartDate(validatedAt: java.util.Date): void;
}
/**
* Entidade Segurança do Documento
*/
declare class DocumentSecurityConfigDto {
/**
* Pega o número do documento
*/
getDocumentId(): number;
/**
* Pega a versão do documento
*/
getVersion(): number;
/**
* Pega o código da empresa em que o documento foi publicado
*/
getCompanyId(): number;
/**
* Pega a matrícula de um colaborador ou o código do grupo que está na segurança do documento
*
* É possível saber se vai retornar um colaborador ou um grupo pelo tipo da segurança.
* Retorna em branco quando o tipo é todos os usuários
*/
getAttributionValue(): string;
/**
* Verifica se é uma permissão
*
* Se não é uma permissão é uma restrição.
*/
getPermission(): boolean;
/**
* Verifica se lista o conteúdo
*/
getShowContent(): boolean;
/**
* Pega o nível de permissão/restrição.
*
* Tipos de permissão/restrição:
* - -1: Sem permissão/restrição (nega acesso)
* - 0: Leitura
* - 1: Gravação
* - 2: Modificação
* - 3: Total
*/
getAttributionType(): number;
/**
* Pega a sequência da permissão/restrição
*/
getSequence(): number;
/**
* Verifica se ele utiliza a segurança desta versão nas demais
*/
getSecurityVersion(): boolean;
};
/**
* Helper para acessar serviços do Fluig
*/
declare namespace fluigAPI {
/**
* Recupera serviço para tratar Notificações
*/
declare function getAlertService(): com.fluig.sdk.service.AlertService;
/**
* Recupera serviço para tratar Artigos
*/
declare function getArticleService(): com.fluig.sdk.service.ArticleService;
/**
* Recupera o serviço de autorização de cliente OAUTH
*/
declare function getAuthorizeClientService(): com.fluig.sdk.service.AuthorizeClientSdkService;
/**
* Recupera o serviço para tratar Card Index
*/
declare function getCardIndexService(): com.fluig.sdk.service.CardIndexService;
/**
* Recupera o serviço para tratar Cards
*/
declare function getCardService(): com.fluig.sdk.service.CardService;
/**
* Recupera o serviço para tratar registros de formulário
*/
declare function CardAPIService(): com.fluig.sdk.service.CardAPIService;
/**
* Recupera o serviço para tratar colaboradores
*/
declare function getCollaborationService(): com.fluig.sdk.service.CollaborationSDKService;
/**
* Recupera serviço para tratar comentários
*/
declare function getCommentService(): com.fluig.sdk.service.CommentService;
/**
* Recupera serviço para tratar Comunidades
*/
declare function getCommunityService(): com.fluig.sdk.service.CommunityService;
/**
* Recupera o serviço para tratar Upload de arquivos
*/
declare function getContentFilesService(): com.fluig.sdk.service.ContentFilesService;
/**
* Recupera o serviço para tratar Documentos
*/
declare function getDocumentService(): com.fluig.sdk.service.DocumentService;
/**
* Recupera serviço para tratar Favoritos
*/
declare function getFavoritesService(): com.fluig.sdk.service.FavoritesService;
/**
* Recupera o serviço do Filter
*/
declare function getFilterService(): com.fluig.sdk.service.FilterAPIService;
/**
* Recupera o serviço para tratar Pastas de documentos
*/
declare function getFolderDocumentService(): com.fluig.sdk.service.FolderDocumentService;
/**
* Recupera serviço para tratar parâmetros gerais
*/
declare function getGlobalParameterService(): com.fluig.sdk.service.GlobalParameterService;
/**
* Recupera o serviço para tratar grupo
*/
declare function getGroupService(): com.fluig.sdk.service.GroupService;
declare function getHelpService(): com.fluig.sdk.service.DocumentationProxyServiceService;
/**
*Recupera o serviço para tratar feriados
*/
declare function getHolidayService(): com.fluig.sdk.service.HolidayAPIService;
/**
* Recupera serviço para tratar linguagem
*/
declare function getI18NService(): com.fluig.sdk.service.I18NService;
declare function getIdentityService(): com.fluig.sdk.service.IdentityService;
/**
* Recupera serviço para Jobs do agendador de tarefas
*/
declare function getJobService(): com.fluig.sdk.service.JobService;
/**
* Recupera o LocalAPIService
*/
declare function getLocalService(): com.fluig.sdk.service.LocalAPIService;
/**
* Recupera serviço para tratar páginas
*/
declare function getPageService(): com.fluig.sdk.service.PageService;
/**
* Recupera serviço para tratar página de widgets
*/
declare function getPageWidgetService(): com.fluig.sdk.service.PageWidgetService;
/**
* Recupera serviço para tratar Post
*/
declare function getPostService(): com.fluig.sdk.service.PostService;
/**
* Recupera serviço para efetuar pesquisas
*/
declare function getSearchService(): com.fluig.sdk.service.SearchService;
/**
* Recupera o serviço de segurança
*/
declare function getSecurityService(): com.fluig.sdk.service.SecurityService;
/**
* Recupera serviço para tratar Breadcrumb do Social
*/
declare function getSocialBreadcrumbService(): com.fluig.sdk.service.SocialBreadcrumbService;
/**
* Recupera serviço do social
*/
declare function getSocialService(): com.fluig.sdk.service.SocialSDKService;
/**
* Recupera o serviço de TagsCloud
*/
declare function getTagsCloudService(): com.fluig.sdk.service.TagsCloudService;
/**
* Recupera serviço para tratar Tasks
*/
declare function getTasksService(): com.fluig.sdk.service.TasksService;
/**
* Recupera o serviço para Tenant
*/
declare function getTenantService(): com.fluig.sdk.service.TenantService;
/**
* Recupera o serviço para tratar Usuário
*/
declare function getUserService(): com.fluig.sdk.service.UserService;
/**
* Recupera o serviço de widgets
*/
declare function getWidgetService(): com.fluig.sdk.service.WidgetService;
/**
* Recupera o serviço para tratar Workflow
*/
declare function getWorkflowService(): com.fluig.sdk.service.WorkflowAPIService;
}
declare type ErrorCallback = (error: ErrorData, data: object) => void;
declare type AutoCompleteOnTagCallback = (item: object, tag: object) => void;
declare type SimpleCallback = () => void;
declare type DataCallback = (data: object) => void;
/**
* Callback de Modal
*
* @param error Indica se houve erro
* @param data Todo o conteúdo da propriedade content da modal
*/
declare type ModalCallback = (error: boolean, data: string) => void;
/**
* Callback de Inicialização do Botão Switch
*
* @param event Evento disparado
* @this HTMLElement
*/
declare type SwitchInitCallback = (event: JQuery.Event) => void;
/**
* Callback de mudança de estado do Botão Switch
*
* @param event Evento disparado
* @param checked Indica se está selecionado
* @this HTMLElement
*/
declare type SwitchChangeCallback = (event: JQuery.Event, checked: boolean) => void;
/**
* Callback da mensagem de Confirmação
*
* @param result Resultado da confirmação (True se clicou em Sim)
* @param element Botão clicado
* @param data Evento disparado
*/
declare type ConfirmCallback = (result: boolean, element: HTMLElement, event: Event) => void;
/**
* Callback de mensagem
*
* @param element Botão clicado
* @param data Evento disparado
*/
declare type MessageCallback = (element: HTMLElement, event: Event) => void;
interface AutoCompleteOptions {
/**
* Tipo do autocomplete
*
* Pode ser (padrão é tag):
* - autocomplete
* - tag
* - tagAutocomplete
*/
type?: string;
/**
* Item exibido na sugestão
*
* Obrigatório para autocomplete e tagAutocomplete
*/
displayKey?: string;
/**
* Nome do dataset
*
* Opcional para autocomplete e tagAutocomplete
*/
name?: string;
/**
* Determina o serviço utilizado para buscar as sugestões
*/
source: {
url: string;
limit: 10,
offset: 0,
limitKey: string;
patternKey: string;
root: string;
};
/**
* Coloca o texto em negrito quando efetua a busca
*/
highlight?: boolean;
/**
* Mínimo de caracteres antes de iniciar a busca
*/
minLength?: number;
/**