C# Class BISDK.Client

Inheritance: RestSharp.RestClient

Show file Open project: brightideainc/bi_api_cs_sdk Class Usage Examples

Public Properties

Property	Type	Description
Email	string
MasterAuthentication	bool
PersistentDataManager	PersistentDataManager

Protected Properties

Property	Type	Description
ClientId	string
ClientSecret	string
_accessToken	string
_customDomain	string
_refreshToken	string

Public Methods

Method	Description
Authenticate ( string email, string password ) : Response
AuthenticateMaster ( ) : Response
AuthenticateMaster ( string email ) : Response
Client ( string clientId, string clientSecret ) : System
DownloadData ( Request request ) : byte[]
Execute ( RestRequest request ) : Response
LoadPersistentData ( ) : bool
ProcessRequest ( RestRequest req ) : void
RenewAccessToken ( string refreshToken ) : object>.Dictionary

Protected Methods

Method	Description
DoExecute ( RestRequest request ) : Response
Execute ( RestRequest request, int retry ) : Response
ProcessError ( int errorCode, string message ) : void
RefreshAccessToken ( ) : void

Method Details

Authenticate() public method

public Authenticate ( string email, string password ) : Response
email	string
password	string
return	Response

AuthenticateMaster() public method

public AuthenticateMaster ( ) : Response
return	Response

AuthenticateMaster() public method

public AuthenticateMaster ( string email ) : Response
email	string
return	Response

Client() public method

public Client ( string clientId, string clientSecret ) : System
clientId	string
clientSecret	string
return	System

DoExecute() protected method

protected DoExecute ( RestRequest request ) : Response
request	RestSharp.RestRequest
return	Response

DownloadData() public method

public DownloadData ( Request request ) : byte[]
request	Request
return	byte[]

Execute() public method

public Execute ( RestRequest request ) : Response
request	RestSharp.RestRequest
return	Response

Execute() protected method

protected Execute ( RestRequest request, int retry ) : Response
request	RestSharp.RestRequest
retry	int
return	Response

LoadPersistentData() public method

public LoadPersistentData ( ) : bool
return	bool

ProcessError() protected method

protected ProcessError ( int errorCode, string message ) : void
errorCode	int
message	string
return	void

ProcessRequest() public method

public ProcessRequest ( RestRequest req ) : void
req	RestSharp.RestRequest
return	void

RefreshAccessToken() protected method

protected RefreshAccessToken ( ) : void
return	void

RenewAccessToken() public method

public RenewAccessToken ( string refreshToken ) : object>.Dictionary
refreshToken	string
return	object>.Dictionary

Property Details

ClientId protected property

protected string ClientId
return	string

ClientSecret protected property

protected string ClientSecret
return	string

Email public property

public string Email
return	string

MasterAuthentication public property

public bool MasterAuthentication
return	bool

PersistentDataManager public property

public PersistentDataManager PersistentDataManager
return	PersistentDataManager

_accessToken protected property

protected string _accessToken
return	string

_customDomain protected property

protected string _customDomain
return	string

_refreshToken protected property

protected string _refreshToken
return	string