Remote
Recurso de invocação remota de APIs.
O Remote facilita esta integração e torna simples a integração com web services externos via REST e SOAP.
acceptJSON
_remote.acceptJSON() : Remote
Descrição
Define que o conteúdo será recebido no formato application/json.
Retorno
( Remote )
A instância atual do Remote.
alwaysBodyData
_remote.alwaysBodyData() : Remote
Descrição
Força os dados irem no corpo do cabeçalho HTTP, até mesmo no caso do método GET
.
Retorno
( Remote )
A instância atual do Remote.
asBinary
_remote.asBinary() : Remote
Descrição
Define que os dados do conteúdo recebido pela conexão remota estão no formato binário, como download de ficheiros, imagens, zip, etc...
Retorno
( Remote )
A instância atual do Remote.
asForm
_remote.asForm() : Remote
Descrição
Define que o conteúdo de dados será submetido no formato application/x-www-form-urlencoded.
Retorno
( Remote )
A instância atual do Remote.
asJSON
_remote.asJSON() : Remote
Descrição
Define que o conteúdo de dados será submetido no formato application/json.
Retorno
( Remote )
A instância atual do Remote.
asMultipartFormData
_remote.asMultipartFormData() : Remote
Descrição
Define que o conteúdo de dados será submetido no formato multipart/form-data.
Retorno
( Remote )
A instância atual do Remote.
asText
_remote.asText() : Remote
Descrição
Define que o conteúdo de dados será submetido no formato text/plain.
Retorno
( Remote )
A instância atual do Remote.
delete
_remote.delete() : RemoteResponse
Descrição
Submete o pedido para a conexão remota através do método DELETE.
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.delete(endereco: string) : RemoteResponse
Descrição
Com o endereço atríbudo submete o pedido para a conexão remota através do método DELETE.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.delete(endereco: string, dados: Values | DataSchema | java.util.Map) : RemoteResponse
Descrição
Com o endereço e mapa de dados atríbudos, submete o pedido para a conexão remota através do método DELETE.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
dados | _Values | DataSchema | java.util.Map_ |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.delete(endereco: string, dados: Values) : RemoteResponse
Descrição
Com o endereço e mapa de dados atríbudos, submete o pedido para a conexão remota através do método DELETE.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
dados | Values | Mapa de dados que serão submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.delete(dados: Values | DataSchema | java.util.Map) : RemoteResponse
Descrição
Com o mapa de dados atríbudos submete o pedido para a conexão remota através do método DELETE.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
dados | _Values | DataSchema | java.util.Map_ |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.delete(dados: Values) : RemoteResponse
Descrição
Com o mapa de dados atríbudos submete o pedido para a conexão remota através do método DELETE.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
dados | Values | Mapa de dados que serão submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
get
_remote.get() : RemoteResponse
Descrição
Submete o pedido para a conexão remota através do método GET.
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.get(endereco: string) : RemoteResponse
Descrição
Com o endereço atríbudo submete o pedido para a conexão remota através do método GET.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.get(endereco: string, dados: Values | DataSchema | java.util.Map) : RemoteResponse
Descrição
Com o endereço e mapa de dados atríbudos, submete o pedido para a conexão remota através do método GET.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
dados | _Values | DataSchema | java.util.Map_ |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.get(endereco: string, dados: Values) : RemoteResponse
Descrição
Com o endereço e mapa de dados atríbudos, submete o pedido para a conexão remota através do método GET.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
dados | Values | Mapa de dados que serão submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.get(dados: Values | DataSchema | java.util.Map) : RemoteResponse
Descrição
Com o mapa de dados atríbudos submete o pedido para a conexão remota através do método GET.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
dados | _Values | DataSchema | java.util.Map_ |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.get(dados: Values) : RemoteResponse
Descrição
Com o mapa de dados atríbudos submete o pedido para a conexão remota através do método GET.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
dados | Values | Mapa de dados que serão submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
getAuthorization
_remote.getAuthorization() : string
Retorno
( string )
getCharset
_remote.getCharset() : string
Retorno
( string )
getConnectTimeout
_remote.getConnectTimeout() : int
Retorno
( int )
getContentType
_remote.getContentType() : string
Retorno
( string )
getData
_remote.getData() : Values
Retorno
( Values )
getDefaultSubmitData
_remote.getDefaultSubmitData() : string
Retorno
( string )
getFormData
_remote.getFormData() : Values
Retorno
( Values )
getHeader
_remote.getHeader() : Values
Retorno
( Values )
getHostAddress
_remote.getHostAddress(host: string) : string
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
host | string |
Retorno
( string )
getQS
_remote.getQS() : Values
Retorno
( Values )
getQueryString
_remote.getQueryString() : Values
Retorno
( Values )
getReadTimeout
_remote.getReadTimeout() : int
Retorno
( int )
getSOAPAction
_remote.getSOAPAction() : string
Retorno
( string )
getSOAPNS
_remote.getSOAPNS() : string
Retorno
( string )
getSOAPURL
_remote.getSOAPURL() : string
Retorno
( string )
getStatusCode
_remote.getStatusCode() : int
Retorno
( int )
getURL
_remote.getURL() : string
Retorno
( string )
getURLPrefix
_remote.getURLPrefix() : string
Retorno
( string )
hostAddress
_remote.hostAddress(servidor: string) : string
Descrição
Obtém o endereço IP de um anfitrião.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
servidor | string | Nome do anfitrião. |
Retorno
( string )
Endereço IP do anfitrião.
init
_remote.init() : Remote
Descrição
Inicia um novo Remote.
Retorno
( Remote )
Nova instância do Remote.
_remote.init(nomeConfig: string) : Remote
Descrição
Inicia um novo Remote com base na chave de configuração.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
nomeConfig | string | Nome da configuração que será utilizada. |
Retorno
( Remote )
Nova instância do Remote.
_remote.init(nomeConfig: Values) : Remote
Descrição
Inicia um novo Remote com base na chave de configuração.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
nomeConfig | Values | Nome da configuração que será utilizada. |
Retorno
( Remote )
Nova instância do Remote.
isAlwaysDataBody
_remote.isAlwaysDataBody() : boolean
Retorno
( boolean )
isBinary
_remote.isBinary() : boolean
Retorno
( boolean )
isFollowRedirects
_remote.isFollowRedirects() : boolean
Retorno
( boolean )
isForm
_remote.isForm() : boolean
Retorno
( boolean )
isJSON
_remote.isJSON() : boolean
Retorno
( boolean )
isMultipartFormData
_remote.isMultipartFormData() : boolean
Retorno
( boolean )
isText
_remote.isText() : boolean
Retorno
( boolean )
json
_remote.json(metodo: string, endereco: string) : RemoteResponse
Descrição
Através do método HTTP e endereço atribuído submete como JSON para a conexão remota.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
metodo | string | Código do método HTTP. |
endereco | string | Endereço que será submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.json(metodo: string, endereco: string, dados: string) : RemoteResponse
Descrição
Através do método HTTP, endereço e mapa de dados atribuído submete os dados como JSON para a conexão remota.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
metodo | string | Código do método HTTP. |
endereco | string | Endereço que será submetido. |
dados | string | Mapa de dados que serão submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.json(metodo: string, endereco: string, dados: Values | DataSchema | java.util.Map) : RemoteResponse
Descrição
Através do método HTTP, endereço e mapa de dados atribuído submete os dados como JSON para a conexão remota.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
metodo | string | Código do método HTTP. |
endereco | string | Endereço que será submetido. |
dados | _Values | DataSchema | java.util.Map_ |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.json(metodo: string, endereco: string, dados: Values) : RemoteResponse
Descrição
Através do método HTTP, endereço e mapa de dados atribuído submete os dados como JSON para a conexão remota.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
metodo | string | Código do método HTTP. |
endereco | string | Endereço que será submetido. |
dados | Values | Mapa de dados que serão submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
patch
_remote.patch() : RemoteResponse
Descrição
Submete o pedido para a conexão remota através do método PATCH.
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.patch(endereco: string) : RemoteResponse
Descrição
Com o endereço atríbudo submete o pedido para a conexão remota através do método PATCH.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.patch(endereco: string, dados: Values | DataSchema | java.util.Map) : RemoteResponse
Descrição
Com o endereço e mapa de dados atríbudos, submete o pedido para a conexão remota através do método PATCH.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
dados | _Values | DataSchema | java.util.Map_ |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.patch(endereco: string, dados: Values) : RemoteResponse
Descrição
Com o endereço e mapa de dados atríbudos, submete o pedido para a conexão remota através do método PATCH.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
dados | Values | Mapa de dados que serão submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.patch(dados: Values | DataSchema | java.util.Map) : RemoteResponse
Descrição
Com o mapa de dados atríbudos submete o pedido para a conexão remota através do método PATCH.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
dados | _Values | DataSchema | java.util.Map_ |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.patch(dados: Values) : RemoteResponse
Descrição
Com o mapa de dados atríbudos submete o pedido para a conexão remota através do método PATCH.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
dados | Values | Mapa de dados que serão submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
ping
_remote.ping(servidor: string) : boolean
Descrição
Verifica se o nome de servidor ou IP está disponível.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
servidor | string | Nome ou IP do servidor. |
Retorno
( boolean )
Resultado se endereço está disponível.
_remote.ping(servidor: string, tempoLimite: int) : boolean
Descrição
Verifica se o nome de servidor ou IP está disponível.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
servidor | string | Nome ou IP do servidor. |
tempoLimite | int | Tempo limite para realizar o ping em milissegundos. |
Retorno
( boolean )
Resultado se endereço está disponível.
portListening
_remote.portListening(servidor: string, porto: int) : boolean
Descrição
Verifica se a porta está disponível para um nome ou IP de servidor.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
servidor | string | Nome ou IP do servidor. |
porto | int | Número do porto. |
Retorno
( boolean )
Resultado se a porta está disponível.
post
_remote.post() : RemoteResponse
Descrição
Submete o pedido para a conexão remota através do método POST.
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.post(endereco: string) : RemoteResponse
Descrição
Com o endereço atríbudo submete o pedido para a conexão remota através do método POST.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.post(endereco: string, dados: Values | DataSchema | java.util.Map) : RemoteResponse
Descrição
Com o endereço e mapa de dados atríbudos, submete o pedido para a conexão remota através do método POST.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
dados | _Values | DataSchema | java.util.Map_ |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.post(endereco: string, dados: Values) : RemoteResponse
Descrição
Com o endereço e mapa de dados atríbudos, submete o pedido para a conexão remota através do método POST.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
dados | Values | Mapa de dados que serão submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.post(dados: Values | DataSchema | java.util.Map) : RemoteResponse
Descrição
Com o mapa de dados atríbudos submete o pedido para a conexão remota através do método POST.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
dados | _Values | DataSchema | java.util.Map_ |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.post(dados: Values) : RemoteResponse
Descrição
Com o mapa de dados atríbudos submete o pedido para a conexão remota através do método POST.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
dados | Values | Mapa de dados que serão submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
put
_remote.put() : RemoteResponse
Descrição
Submete o pedido para a conexão remota através do método PUT.
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.put(endereco: string) : RemoteResponse
Descrição
Com o endereço atríbudo submete o pedido para a conexão remota através do método PUT.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.put(endereco: string, dados: Values | DataSchema | java.util.Map) : RemoteResponse
Descrição
Com o endereço e mapa de dados atríbudos, submete o pedido para a conexão remota através do método PUT.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
dados | _Values | DataSchema | java.util.Map_ |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.put(endereco: string, dados: Values) : RemoteResponse
Descrição
Com o endereço e mapa de dados atríbudos, submete o pedido para a conexão remota através do método PUT.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
endereco | string | Endereço que será submetido. |
dados | Values | Mapa de dados que serão submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.put(dados: Values | DataSchema | java.util.Map) : RemoteResponse
Descrição
Com o mapa de dados atríbudos submete o pedido para a conexão remota através do método PUT.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
dados | _Values | DataSchema | java.util.Map_ |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.
_remote.put(dados: Values) : RemoteResponse
Descrição
Com o mapa de dados atríbudos submete o pedido para a conexão remota através do método PUT.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
dados | Values | Mapa de dados que serão submetido. |
Retorno
( RemoteResponse )
Resposta da submissão, com o estado, cabeçalho, conteúdo, etc.