Descrição
Objeto client Client para fazer autenticação de acordo com o protocolo oAuth
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():NEW( <cConsumer> , <cSecret> , <oURL> , <cCallback> )->self
Descrição Método construtor da classe
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cConsumer | Caracteres | Consumer Key |
| |
|
| | cSecret | Caracteres | Consumer Secret |
| | |
| X | | cCallback | Caracteres | Url definida para o Callback |
| | | | | | | | |
| Painel |
|---|
|
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():Get( cURL, cQuery, cBody, aHeadOut, cHeadRet, lUTF8 )->cResponse
Descrição Consome o serviço indicado pela URL via GET
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cURL | Caracteres | cUrl corresponde ao endereço HTTP, juntamente com a pasta e o documento solicitados. |
| X | | cQuery | Caracteres | Parâmetros a serem enviados no GET |
|
| | cBody | Objeto | Parâmetros enviados no Body |
|
| | aHeadOut | Array | Através deste parâmetro, podemos especificar um array com strings a serem acrescentadas ao Header da requisição HTTP a ser realizada. |
|
| | cHeadRet | Caracteres | Retorna através de referência o header de resposta HTTP enviado pelo servidor requisitado. Variável deve ser declarada antes da chamada da função. |
|
| | lUTF8 | Lógico | Define se vai encodar com UTF8 o cBody |
|
|
Retorno cResponse (caracter) - Através de cResponse será retornada a String correspondendo ao documento solicitado.
|
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():Post( cURL, cQuery, cBody, aHeadOut, cHeadRet, lUTF8 )->cResponse
Descrição Consome o serviço indicado pela URL via Post
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cURL | Caracteres | cUrl corresponde ao endereço HTTP, juntamente com a pasta e o documento solicitados. |
| X | | cQuery | Caracteres | Parâmetros a serem enviados no Post |
|
| | cBody | Objeto | Parâmetros enviados no Body |
|
| | aHeadOut | Array | Através deste parâmetro, podemos especificar um array com strings a serem acrescentadas ao Header da requisição HTTP a ser realizada. |
|
| | cHeadRet | Caracteres | Retorna através de referência o header de resposta HTTP enviado pelo servidor requisitado. Variável deve ser declarada antes da chamada da função. |
|
| | lUTF8 | Lógico | Define se vai encodar com UTF8 o cBody |
|
|
Retorno cResponse (caracter) - Através de cResponse será retornada a String correspondendo ao documento solicitado.
|
| Painel |
|---|
| title | Put | title | SetConsumerKey |
|---|
|
Sintaxe FWOAUTHCLIENT():SetConsumerKey( <cConsumerKey> )->nil Descrição Indica a Consumer Key Parâmetros Put( cURL, cQuery, cBody, aHeadOut, cHeadRet, lUTF8 )->cResponse
Descrição Consome o serviço indicado pela URL via Put
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cURL | Caracteres | cUrl corresponde ao endereço HTTP, juntamente com a pasta e o documento solicitados. |
| X | | cQuery | Caracteres | Parâmetros a serem enviados no Put |
|
| | cBody | Objeto | Parâmetros enviados no Body |
|
| | aHeadOut | Array | Através deste parâmetro, podemos especificar um array com strings a serem acrescentadas ao Header da requisição HTTP a ser realizada. |
|
| | cHeadRet | Caracteres | Retorna através de referência o header de resposta HTTP enviado pelo servidor requisitado. Variável deve ser declarada antes da chamada da função. |
|
| | lUTF8 | Lógico | Define se vai encodar com UTF8 o cBody |
|
|
Retorno cResponse (caracter) - Através de cResponse será retornada a String correspondendo ao documento solicitado.
|
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():Delete( cURL, cQuery, cBody, aHeadOut, cHeadRet, lUTF8 )->cResponse
Descrição Consome o serviço indicado pela URL via Delete
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cConsumerKey | Caracteres | Consumer Key | | | | | | | |
|---|
| cURL | Caracteres | cUrl corresponde ao endereço HTTP, juntamente com a pasta e o documento solicitados. |
| X | | cQuery | Caracteres | Parâmetros a serem enviados no Delete |
|
| | cBody | Objeto | Parâmetros enviados no Body |
|
| | aHeadOut | Array | Através deste parâmetro, podemos especificar um array com strings a serem acrescentadas ao Header da requisição HTTP a ser realizada. |
|
| | cHeadRet | Caracteres | Retorna através de referência o header de resposta HTTP enviado pelo servidor requisitado. Variável deve ser declarada antes da chamada da função. |
|
| | lUTF8 | Lógico | Define se vai encodar com UTF8 o cBody |
|
|
Retorno cResponse (caracter) - Através de cResponse será retornada a String correspondendo ao documento solicitado.
|
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():SetConsumerKey( <cConsumerKey> )->nil
Descrição Indica a Consumer Key
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cConsumerKey | Caracteres | Consumer Key |
|
|
|
|
|
|
|
|
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():SetSecretKey( <cSecretKey> )->nil
Descrição Indica a Secret Key (Consumer Secret)
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cSecretKey | Caracteres | Secret Key |
| | | | | | | | |
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():SetSignature( <cSignature> )->nil
Descrição Indica a assinatura a ser utilizada
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cSignature | Caracteres | Assinatura a ser utilizada |
| | | | | | | | |
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():SetMethodSignature( <cMethodSignature> )->nil
Descrição Indica o método de assinatura
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cMethodSignature | Caracteres | método de assinatura |
| | | | | | |
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():SetTimeStamp( <cTimeStamp> )->nil
Descrição Indica o TimeStamp a ser utilizado
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cTimeStamp | Caracteres | TimeStamp a ser utilizado |
|
|
|
|
|
|
|
|
| Painel |
|---|
| title | SetTimeStampSetNonce |
|---|
|
Sintaxe FWOAUTHCLIENT():SetTimeStampSetNonce( <cTimeStamp> <cNonce> )->nil
Descrição Indica o TimeStamp Nonce a ser utilizado
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cNonce | Caracteres | Nonce a ser utilizado |
Parâmetros |
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():SetURLRequestToken( <cURLRequestToken> )->nil
Descrição Indica a URL para pedido de Token
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cURLRequestToken | Caracteres | URL a ser utilizada para pedido de token |
|
|
|
|
|
|
|
|
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():SetURLAuthorize( <cURLAuthorize> )->nil
Descrição Indica a URL para pedido de autorização
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
cTimeStampTimeStamp a ser utilizado | | | | | | | | | |
| URL a ser utilizada para autorização. |
|
|
|
|
|
|
|
|
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():SetToken( <cToken> )->nil
Descrição Atribui o token
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cToken | Caracteres | token |
|
|
|
|
|
|
|
|
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():SetSecretToken( <cSecretToken> )->nil
Descrição Atribui o secret token, ou access token
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cSecretToken | Caracteres | secret token, ou access token |
|
|
|
|
|
|
|
|
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():SetContentType( <cContentType> )->nil
Descrição Atribui o valor do content-type que será enviado ao efetuar o consumo de um serviço
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cContentType | Caracteres | content-type que será enviado ao efetuar o consumo de um serviço |
|
|
|
|
|
|
|
|
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():MakeSignBaseString( <cMethod>, <cURL> )->nil
Descrição Monta a BaseString baseada nos parâmetros que serão enviados, na URL e no método através do método MakeSignature()
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| cMethod | Caracteres | Indica se é um GET ou POST. |
|
| | cURL | Caracteres | Indica a URL que a BaseString será enviada. |
|
|
|
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():RequestToken( )->nil
Descrição Faz o pedido de Token e define o Token e o SecretToken.
|
| Painel |
|---|
|
Sintaxe FWOAUTHCLIENT():AccessToken( )->nil
Descrição Redireciona o usuário para a página de autorização
Parâmetros | Nome | Tipo | Descrição | Default | Obrigatório |
|---|
| aExtras | Caracteres | Array aonde serão carregados os valores de retorno da requisição por referência após a execução do método, com exceção dos valores do OAUTH_TOKEN e OAUTH_TOKEN_SECRET |
|
...
