You.i Engine
CYIServer Class Reference

Detailed Description

This class contains various data used when authenticating with a server.

#include <network/YiServer.h>

Public Types

enum  OAuthSignature {
  OAuthSignature::HMAC_SHA1,
  OAuthSignature::RSA_SHA1
}
 
enum  OAuthVersion { OAuthVersion::v10a }
 

Public Member Functions

 CYIServer ()
 
 CYIServer (const CYIServer &rServer)
 
 CYIServer (const CYIString &rAppKey, const CYIString &rAppSecret, OAuthSignature oAuthSignature, OAuthVersion oAuthVersion)
 
 ~CYIServer ()
 
CYIServeroperator= (const CYIServer &rRHS)
 
const CYIStringGetAppKey () const
 
const CYIStringGetAppSecret () const
 
const CYIStringGetSignatureMethod () const
 
OAuthVersion GetVersion () const
 
const CYIStringGetAccessToken () const
 
const CYIStringGetAccessTokenSecret () const
 
void SetAppKey (const CYIString &rKey)
 
void SetAppSecret (const CYIString &rSecret)
 
void SetSignatureMethod (OAuthSignature oAuthSignature)
 
void SetVersion (OAuthVersion oAuthVersion)
 
void SetAccessToken (const CYIString &rAccessToken)
 
void SetAccessTokenSecret (const CYIString &rAccessTokenSecret)
 

Member Enumeration Documentation

Enumerator
HMAC_SHA1 
RSA_SHA1 
Enumerator
v10a 

Constructor & Destructor Documentation

CYIServer::CYIServer ( )

Constructs a default CYIServer object with OAuthSignature::HMAC_SHA1 OAuth signature and OAth version OAuthVersion::v10a.

CYIServer::CYIServer ( const CYIServer rServer)

Constructs a CYIServer object with the parameters of another CYIServer object.

CYIServer::CYIServer ( const CYIString rAppKey,
const CYIString rAppSecret,
OAuthSignature  oAuthSignature,
OAuthVersion  oAuthVersion 
)

Constructs a CYIServer object providing all application specific server parameters.

CYIServer::~CYIServer ( )

Member Function Documentation

const CYIString& CYIServer::GetAccessToken ( ) const

Return user's Access Token configured for this server

const CYIString& CYIServer::GetAccessTokenSecret ( ) const

Return the secret associated with the user's Access Token.

const CYIString& CYIServer::GetAppKey ( ) const

Return the Application key. This key identifies the client application to the server. This key is typically used for computing the hash used in a signature.

const CYIString& CYIServer::GetAppSecret ( ) const

Return the Application secret. This secret represent shared information between the client and server. It is typically used for computing the hash used in a signature.

const CYIString& CYIServer::GetSignatureMethod ( ) const

Return the Signature algorithm used during encryption.

OAuthVersion CYIServer::GetVersion ( ) const

Return the OAuth verion used.

CYIServer& CYIServer::operator= ( const CYIServer rRHS)
void CYIServer::SetAccessToken ( const CYIString rAccessToken)

Sets the user's Access Token retrieved after successful login.

void CYIServer::SetAccessTokenSecret ( const CYIString rAccessTokenSecret)

Sets the user's Access Token Secret retrieved after successful login.

void CYIServer::SetAppKey ( const CYIString rKey)

Sets the Application key.

void CYIServer::SetAppSecret ( const CYIString rSecret)

Sets the Application secret.

void CYIServer::SetSignatureMethod ( OAuthSignature  oAuthSignature)

Sets the Signature method.

void CYIServer::SetVersion ( OAuthVersion  oAuthVersion)

Sets the OAuth version to be used.


The documentation for this class was generated from the following file: