Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Painel
titleNew

Sintaxe

FWOAUTHCLIENT():NEW( <cConsumer> , <cSecret> , <oURL> , <cCallback> )->self

 

Descrição

Método construtor da classe

 

Parâmetros

 

NomeTipoDescriçãoDefaultObrigatório
cConsumerCaracteresConsumer Key  
cSecretCaracteresConsumer Secret  
oURLObjetoObjeto FWoAuthURL X
cCallbackCaracteresUrl definida para o Callback  
     

 

 

Painel
titleGet

Sintaxe

FWOAUTHCLIENT():Get( cURL, cQuery, cBody, aHeadOut, aArray cHeadRet, lUTF8 )->nil>cResponse

 

Descrição

Consome o serviço indicado pela URL via GET

 

Parâmetros

 

NomeTipoDescriçãoDefaultObrigatório
cURLCaracterescUrl corresponde ao endereço HTTP, juntamente com a pasta e o documento solicitados. X
cQueryCaracteresParâmetros a serem enviados no GET  
cBodyObjetoParâmetros enviados no Body  
aHeadOutArrayAtravés deste parâmetro, podemos especificar um array com strings a serem acrescentadas ao Header da requisição HTTP a ser realizada.  
cHeadRetCaracteresRetorna 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.  
lUTF8LógicoDefine se vai encodar com UTF8 o cBody  

 

Retorno

cResponse (caracter)

  • Através de cResponse será retornada a String correspondendo ao documento solicitado.


Painel
titlePost

Sintaxe

FWOAUTHCLIENT():Post( cURL, cQuery, cBody, aHeadOut, cHeadRet, lUTF8 )->cResponse

 

Descrição

Consome o serviço indicado pela URL via Post

 

Parâmetros

 

NomeTipoDescriçãoDefaultObrigatório
cURLCaracterescUrl corresponde ao endereço HTTP, juntamente com a pasta e o documento solicitados. X
cQueryCaracteresParâmetros a serem enviados no Post  
cBodyObjetoParâmetros enviados no Body  
aHeadOutArrayAtravés deste parâmetro, podemos especificar um array com strings a serem acrescentadas ao Header da requisição HTTP a ser realizada.  
cHeadRetCaracteresRetorna 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.  
lUTF8LógicoDefine se vai encodar com UTF8 o cBody  

 

Retorno

cResponse (caracter)

  • Através de cResponse será retornada a String correspondendo ao documento solicitado.
Painel
titlePut

Sintaxe

FWOAUTHCLIENT():Put( cURL, cQuery, cBody, aHeadOut, cHeadRet, lUTF8 )->cResponse

 

Descrição

Consome o serviço indicado pela URL via Put

 

Parâmetros

 

NomeTipoDescriçãoDefaultObrigatório
cURLCaracterescUrl corresponde ao endereço HTTP, juntamente com a pasta e o documento solicitados. X
cQueryCaracteresParâmetros a serem enviados no Put  
cBodyObjetoParâmetros enviados no Body  
aHeadOutArrayAtravés deste parâmetro, podemos especificar um array com strings a serem acrescentadas ao Header da requisição HTTP a ser realizada.  
cHeadRetCaracteresRetorna 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.  
lUTF8LógicoDefine se vai encodar com UTF8 o cBody  

 

Retorno

cResponse (caracter)

  • Através de cResponse será retornada a String correspondendo ao documento solicitado.

Painel
titleDelete

Sintaxe

FWOAUTHCLIENT():Delete( cURL, cQuery, cBody, aHeadOut, cHeadRet, lUTF8 )->cResponse

 

Descrição

Consome o serviço indicado pela URL via Delete

 

Parâmetros

 

NomeTipoDescriçãoDefaultObrigatório
cURLCaracterescUrl corresponde ao endereço HTTP, juntamente com a pasta e o documento solicitados. X
cQueryCaracteresParâmetros a serem enviados no Delete  
cBodyObjetoParâmetros enviados no Body  
aArrayaHeadOutArrayNão UtilizadoAtravés deste parâmetro, podemos especificar um array com strings a serem acrescentadas ao Header da requisição HTTP a ser realizada.  
cHeadRetCaracteresRetorna 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.  
lUTF8LógicoDefine se vai encodar com UTF8 o cBody  

 

Retorno

cResponse (caracter)

  • Através de cResponse será retornada a String correspondendo ao documento solicitado.

 

Painel
titleSetConsumerKey

Sintaxe

FWOAUTHCLIENT():SetConsumerKey( <cConsumerKey> )->nil

 

Descrição

Indica a Consumer Key

 

Parâmetros

 

NomeTipoDescriçãoDefaultObrigatório
cConsumerKeyCaracteresConsumer Key  
     

...

Painel
titleMakeSignBaseString

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

 

NomeTipoDescriçãoDefaultObrigatório
cMethodCaracteresIndica se é um GET ou POST.  
 cURLCaracteresIndica a URL que a BaseString será enviada.  
Painel
titleRequestToken

Sintaxe

FWOAUTHCLIENT():RequestToken( )->nil

 

Descrição

Faz o pedido de Token e define o Token e o SecretToken.

 

Painel
titleAccessToken

Sintaxe

FWOAUTHCLIENT():AccessToken( )->nil

 

Descrição

Redireciona o usuário para a página de autorização


Parâmetros

NomeTipoDescriçãoDefaultObrigatório
aExtrasCaracteresArray contendo parâmetros extras a serem enviados.