Para ter acesso a funções relacionadas a documentos é possível utilizar nos eventos a variável global docAPI. Os métodos disponíveis através da docAPI são:
Método | Especificação | ||
---|---|---|---|
copyDocumentToUploadArea(documentId, version) | Copia os arquivos físicos de um documento existente para a área de upload do usuário logado, onde:
Retorno: Array de Strings contendo os nomes dos arquivos que foram disponibilizados na área de upload. | ||
createDocument(document, attachments, securityConfig, approvers, relatedDocs) | Cria um novo documento no GED de acordo com os parâmetros informados, onde:
Retorno: DocumentDto do documento criado. Exemplo de utilização desta função em conjunto com a função copyDocumentToUploadArea:
| ||
createFolder(document, securityConfig, approvers) | Cria uma nova pasta no GED de acordo com os parâmetros informados, onde:
Retorno: DocumentDto da pasta criada. Exemplo de utilização desta função:
Confira um exemplo de como criar pastas definindo sua segurança por grupos e usuários clicando aqui. | ||
getDocumentVersion(documentId, version) | Retorna o DocumentDto de um documento com base no seu id e sua versão, onde:
| ||
getUserPermissions(documentId, version) | Retorna o nível de permissão do usuário logado no documento informado, onde:
| ||
isUserInGroup(group) | Retorna se o usuário logado faz parte do grupo informado, onde:
| ||
newAttachment() | Retorna uma nova instância de Attachment. | ||
newRelatedDocumentDto() | Retorna uma nova instância de RelatedDocumentDto. | ||
newDocumentSecurityConfigDto() | Retorna uma nova instancia de DocumentSecurityConfigDto. | ||
newApproverDto() | Retorna uma nova instância de ApproverDto. | ||
newDocumentDto() | Retorna uma nova instância de DocumentDto, com o tipo 2 (Documento) como padrão. |