Frameworksp

Páginas filhas
  • FWoAuthClient

Versões comparadas

Versão antiga 7

changes.mady.by.user Ricardo Augusto Da Costa

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Fanny Mieko Suzuki

Gravado em

Chave

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

Descrição

Objeto client Client para fazer autenticação de acordo com o protocolo oAuth 


 
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, cHeadRet, lUTF8 )->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)

 
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)

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
 
 


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)

 


 
Painel
titleSetConsumerKey

Sintaxe

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

 


Descrição

Indica a Consumer Key 


Parâmetros


 

NomeTipoDescriçãoDefaultObrigatório
cConsumerKeyCaracteresConsumer Key
  
    







Painel
titleSetSecretKey

Sintaxe

FWOAUTHCLIENT():SetSecretKey( <cSecretKey> )->nil 


Descrição

Indica a Secret Key (Consumer Secret)

 


Parâmetros

 


NomeTipoDescriçãoDefaultObrigatório
cSecretKeyCaracteresSecret Key (Consumer Secret)
  
     







 
Painel
titleSetSignature

Sintaxe

FWOAUTHCLIENT():SetSignature( <cSignature> )->nil

 


Descrição

Indica a assinatura a ser utilizada 


Parâmetros

 


NomeTipoDescriçãoDefaultObrigatório
cSignatureCaracteresAssinatura a ser utilizada
  
    







 
Painel
titleSetMethodSignature

Sintaxe

FWOAUTHCLIENT():SetMethodSignature( <cMethodSignature> )->nil 


Descrição

Indica o método de assinatura

 


Parâmetros

 


NomeTipoDescriçãoDefaultObrigatório
cMethodSignatureCaracteresmétodo de assinatura
 
     







 
Painel
titleSetTimeStamp

Sintaxe

FWOAUTHCLIENT():SetTimeStamp( <cTimeStamp> )->nil

 


Descrição

Indica o TimeStamp a ser utilizado 


Parâmetros


 

NomeTipoDescriçãoDefaultObrigatório
cTimeStampCaracteresTimeStamp a ser utilizado
    
  

 

 










Painel
titleSetNonce

Sintaxe

FWOAUTHCLIENT():SetNonce( <cNonce> )->nil 


Descrição

Indica o Nonce a ser utilizado 


Parâmetros

 


NomeTipoDescriçãoDefaultObrigatório
cNonceCaracteresNonce a ser utilizado
  
     

 

 










 
Painel
titleSetURLRequestToken

Sintaxe

FWOAUTHCLIENT():SetURLRequestToken( <cURLRequestToken> )->nil

 


Descrição

Indica a URL para pedido de Token

 


Parâmetros


 

NomeTipoDescriçãoDefaultObrigatório
cURLRequestTokenCaracteresURL a ser utilizada para pedido de token
  
    

 

 










 
Painel
titleSetURLAuthorize

Sintaxe

FWOAUTHCLIENT():SetURLAuthorize( <cURLAuthorize> )->nil 


Descrição

Indica a URL para pedido de autorização 


Parâmetros

 


NomeTipoDescriçãoDefaultObrigatório
cURLAuthorizeCaracteresURL a ser utilizada para autorização.
    
  

 

 










 
Painel
titleSetToken

Sintaxe

FWOAUTHCLIENT():SetToken( <cToken> )->nil

 


Descrição

Atribui o token 


Parâmetros


 

NomeTipoDescriçãoDefaultObrigatório
cTokenCaracterestoken
 
     







Painel
titleSetSecretToken

Sintaxe

FWOAUTHCLIENT():SetSecretToken( <cSecretToken> )->nil 


Descrição

Atribui o secret token, ou access token

 


Parâmetros

 


NomeTipoDescriçãoDefaultObrigatório
cSecretTokenCaracteressecret token, ou access token
  
     







 
Painel
titleSetSecretToken

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

 


NomeTipoDescriçãoDefaultObrigatório
cContentTypeCaracterescontent-type que será enviado ao efetuar o consumo de um serviço
 
     







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.
      
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