CYIServer Class Reference

Detailed Description

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

#include <network/YiServer.h>

Public Types
enum	OAUTH_SIGNATURE {   HMAC_SHA1,   RSA_SHA1 }
enum	OAUTH_VERSION { v10a }

Public Member Functions
	CYIServer ()
	CYIServer (const CYIServer &rServer)
	CYIServer (const CYIString &rAppKey, const CYIString &rAppSecret, OAUTH_SIGNATURE eOAuthSignature, OAUTH_VERSION eOAuthVersion)
	~CYIServer ()
CYIServer &	operator= (const CYIServer &rRHS)
const CYIString &	GetAppKey () const
const CYIString &	GetAppSecret () const
const CYIString &	GetSignatureMethod () const
OAUTH_VERSION	GetVersion () const
const CYIString &	GetAccessToken () const
const CYIString &	GetAccessTokenSecret () const
void	SetAppKey (const CYIString &rKey)
void	SetAppSecret (const CYIString &rSecret)
void	SetSignatureMethod (OAUTH_SIGNATURE eOAuthSignature)
void	SetVersion (OAUTH_VERSION eOAuthVersion)
void	SetAccessToken (const CYIString &rAccessToken)
void	SetAccessTokenSecret (const CYIString &rAccessTokenSecret)

Member Enumeration Documentation

enum CYIServer::OAUTH_SIGNATURE

Enumerator
HMAC_SHA1
RSA_SHA1

enum CYIServer::OAUTH_VERSION

Enumerator
v10a

Constructor & Destructor Documentation

CYIServer::CYIServer

(

)

Constructs a default CYIServer object with HMAC_SHA1 OAuth signature and OAth version 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,
		OAUTH_SIGNATURE	eOAuthSignature,
		OAUTH_VERSION	eOAuthVersion
	)

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.

OAUTH_VERSION 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

(

OAUTH_SIGNATURE

eOAuthSignature

)

Sets the Signature method.

void CYIServer::SetVersion

(

OAUTH_VERSION

eOAuthVersion

)

Sets the OAuth version to be used.

---

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

• network/YiServer.h