Histórico da Página
Classe que realiza a integração com o TAE diretamente sem interface.
Sintaxe
FwTotvsSign() |
Retorno
Nome | Tipo | Descrição |
|---|---|---|
oSign | objeto | instância do motor de envio de documentos |
authenticate()
Realiza a autenticação no serviço do TAE. Ao realizar a autenticação com sucesso, as credenciais são armazenadas para novos usos. Caso já exista credencial válida armazenada
não é necessário informar novas credenciais. A credencial fica vinculada ao usuário logado no sistema.
Sintaxe
oSign:authenticate()-> Nil
Parâmetros
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|---|---|---|---|---|---|
| cUser | Caracter | Usuário no TAE. Caso não seja passado tenta utilizar a credencial armazenada. | |||
| cPassword | Caracter | Senha no TAE. Caso não seja passado tenta utilizar a credencial armazenada. |
isAuthenticated()
Retorna se está autenticada no TAE.
Sintaxe
oSign:isAuthenticated()-> logical
Retorno
Tipo | Descrição |
|---|---|
| logical | Autenticado se verdadeiro |
isAuthenticated()
Retorna se está autenticada no TAE.
Sintaxe
oSign:isAuthenticated()-> logical
Retorno
Tipo | Descrição |
|---|---|
| logical | Autenticado se verdadeiro |
uploadDocument()
Realiza o upload de um documento para o TAE.
Sintaxe
oSign:uploadDocument()-> logical
Parâmetros
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|---|---|---|---|---|---|
| cFilePath | Caracter | Caminho do arquivo. Pode ser absoluto ou relativo. | X |
Retorno
Tipo | Descrição |
|---|---|
| logical | sucesso ou falha na operação |
requestAction()
Solicita a ação de n destinatários.
Sintaxe
oSign:requestAction()-> logical
Parâmetros
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|---|---|---|---|---|---|
| nDocumentId | Numeric | Id do documento no TAE. | X | ||
aReceiver | Array | Destinatários. Formato: { { cEmail, nAcao } }. Ações possíveis: 0-Assinar | X |
Retorno
Tipo | Descrição |
|---|---|
| logical | sucesso ou falha na operação |
uploadSignedDocument()
Realiza o upload de um documento assinado digitalmente para o TAE.
Sintaxe
oSign:uploadSignedDocument()-> logical
Parâmetros
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|---|---|---|---|---|---|
| nDocumentId | Numeric | Id do documento no TAE. | X | ||
| cFilePath | Caracter | Caminho do arquivo. Pode ser absoluto ou relativo. | X |
Retorno
Tipo | Descrição |
|---|---|
| logical | sucesso ou falha na operação |
downloadDocument()
Realiza o download de um documento no TAE. O nome do arquivo será o retornado pela API.
Sintaxe
oSign:downloadDocument()-> Nil
Parâmetros
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|---|---|---|---|---|---|
| nDocumentId | Numeric | Id do documento no TAE. | X | ||
| cFilePath | Caracter | Pasta para gravação do arquivo | X | ||
| cDocumentType | Caracter | Tipo do documento. Tipos possíveis: 1 - Original | "3" |
Retorno
Tipo | Descrição |
|---|---|
| logical | sucesso ou falha na operação |
deleteDocument()
Realiza a deleção do documento no TAE.
Sintaxe
oSign:deleteDocument()-> logical
Parâmetros
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|---|---|---|---|---|---|
| nDocumentId | Numeric | Id do documento no TAE. | X |
Retorno
Tipo | Descrição |
|---|---|
| logical | sucesso ou falha na operação |
documentStatus()
Recupera o status de um documento no TAE.
Sintaxe
oSign:documentStatus()-> logical
Parâmetros
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|---|---|---|---|---|---|
| nDocumentId | Numeric | Id do documento no TAE. | X |
Retorno
Tipo | Descrição |
|---|---|
| logical | sucesso ou falha na operação |
getResponse()
Recupera a resposta do último método da plataforma chamado.
Sintaxe
oSign:getResponse()->json
Retorno
Tipo | Descrição |
|---|---|
| json | Resposta do TAE |
destroy()
Realiza a limpeza da classe
Sintaxe
oSign:destroy()->Nil
Exemplo básico de utilização
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas