AdventureRes PHP SDK
\
AdventureRes
Authentication
Exceptions
Http
HttpClients
Models
Input
Output
PersistentData
Services

\AdventureResAdventureResApp

Class AdventureResApp

Summary

Methods
Properties
Constants
__construct()
getBaseDomain()
setBaseDomain()
getApiKey()
setApiKey()
getUsername()
setUsername()
getPassword()
setPassword()
getLocation()
setLocation()
getDataHandler()
setDataHandler()
No public properties found
No constants found
No protected methods found
$baseDomain
$apiKey
$username
$password
$location
$dataHandler
N/A
No private methods found
No private properties found
N/A

Properties

$baseDomain

$baseDomain : string

Type

string

$apiKey

$apiKey : string

Type

string

$username

$username : string

Type

string

$password

$password : string

Type

string

$location

$location : integer

Type

integer — The location ID set from configs.

Methods

__construct()

__construct(string  $baseDomain = null, string  $apiKey = null, string  $username = null, string  $password = null, integer  $location = null,   $dataHandler = null)

AdventureResApp constructor.

Parameters

string $baseDomain
string $apiKey
string $username
string $password
integer $location
$dataHandler

getBaseDomain()

getBaseDomain() : string

Gets the configured base domain.

Returns

string

setBaseDomain()

setBaseDomain(string  $baseDomain)

Sets the base domain.

Parameters

string $baseDomain

getApiKey()

getApiKey() : string

Gets the configured API key.

Returns

string

setApiKey()

setApiKey(string  $apiKey)

Sets the API key.

Parameters

string $apiKey

getUsername()

getUsername() : string

Gets the configured username.

Returns

string

setUsername()

setUsername(string  $username)

Sets the username.

Parameters

string $username

getPassword()

getPassword() : string

Gets the configured Password.

Returns

string

setPassword()

setPassword(string  $password)

Sets the password.

Parameters

string $password

getLocation()

getLocation() : integer

Gets the configured Location.

Returns

integer

setLocation()

setLocation(integer  $location)

Sets the location.

Parameters

integer $location

getDataHandler()

getDataHandler() : mixed

Returns

mixed

setDataHandler()

setDataHandler(mixed  $dataHandler)

Parameters

mixed $dataHandler