Docs For Class API

Methods

checkMyFunds [line 185]

boolean checkMyFunds(
[string
$email = null], [string
$key = null], double
$amount, string
$currency, int
4 
)

Check my account balance

Parameters:

int	4:	Member ID
string	$email:	SOAP-API auth email
string	$key:	SOAP-API auth session code
double	$amount:	Amount of funds to check
string	$currency:	Currency of input funds

API Tags:

Return:	True if has sufficent funds
Access:	public

Redefined in descendants as:

AfterMarket::checkMyFunds() : Check my account balance
DomainManager::checkMyFunds() : Check my account balance

[ Top ]

getCurrentTime [line 131]

int getCurrentTime(
string
$email, string
$key 
)

Returns current time as a Unix timestamp.

Parameters:

string	$email:	User email
string	$key:	User authorization code

API Tags:

Return:	Current timestamp
Access:	public

Redefined in descendants as:

AfterMarket::getCurrentTime() : Returns current time as a Unix timestamp.
DomainManager::getCurrentTime() : Returns current time as a Unix timestamp.

[ Top ]

getMyBalance [line 155]

float getMyBalance(
string
$email, string
$key 
)

Returns current balance on the account.

Parameters:

string	$email:	User email
string	$key:	User authorization code

API Tags:

Return:	Account balance
Access:	public

Redefined in descendants as:

AfterMarket::getMyBalance() : Returns current balance on the account.
DomainManager::getMyBalance() : Returns current balance on the account.

[ Top ]

getMyCurrency [line 168]

string getMyCurrency(
string
$email, string
$key 
)

Returns the account currency.

Parameters:

string	$email:	User email
string	$key:	User authorization code

API Tags:

Return:	Account currency
Access:	public

Redefined in descendants as:

AfterMarket::getMyCurrency() : Returns the account currency.
DomainManager::getMyCurrency() : Returns the account currency.

[ Top ]

getMyUserId [line 143]

string getMyUserId(
string
$email, string
$key 
)

Returns the identifier of the logged-in user.

Parameters:

string	$email:	User email
string	$key:	User authorization code

API Tags:

Return:	User identifier
Access:	public

Redefined in descendants as:

AfterMarket::getMyUserId() : Returns the identifier of the logged-in user.
DomainManager::getMyUserId() : Returns the identifier of the logged-in user.

[ Top ]

keepAlive [line 119]

boolean keepAlive(
string
$email, string
$key 
)

Null function - does nothing.

This function can be used as a "keep alive" mechanism to prevent the authentication session from expiring.

Parameters:

string	$email:	User email
string	$key:	User authorization code

API Tags:

Access:

public

Redefined in descendants as:

AfterMarket::keepAlive() : Null function - does nothing.
DomainManager::keepAlive() : Null function - does nothing.

[ Top ]

string login(
string
$email, string
$password, [string
$lang = "pl"] 
)

Creates a new session for specified user, returns session authorization code.

This function is used to open an authenticated API session. Upon succesful execution, an API authorization code is returned, which must be used in all subsequent API calls.

Parameters:

string	$email:	User email
string	$password:	User password
string	$lang:	Session language

API Tags:

Return:	Authorization code
Access:	public

Information Tags:

Throws:

Exceptions: 10002, 10004, 10006 (see ErrorCodesDM.pkg)

Redefined in descendants as:

AfterMarket::login() : Creates a new session for specified user, returns session authorization code.
DomainManager::login() : Creates a new session for specified user, returns session authorization code.

[ Top ]

logout [line 102]

boolean logout(
string
$email, string
$key 
)

Closes user session

This function terminates the authentication session created by the login() function.

Parameters:

string	$email:	User email
string	$key:	User authorization code

API Tags:

Access:

public

Redefined in descendants as:

AfterMarket::logout() : Closes user session
DomainManager::logout() : Closes user session

[ Top ]

	AfterMarket

[ class tree: AfterMarket ] [ index: AfterMarket ] [ all elements ]

Class: API

Class API