Methods summary
public
|
#
__construct( $apiKey = NULL )
Constructor with authentication and configuration parameters
Constructor with authentication and configuration parameters
|
public
|
#
setHttpCallBack( Inventorus\Http\HttpCallBack $httpCallBack )
Set HttpCallBack for this controller
Set HttpCallBack for this controller
Parameters
- $httpCallBack
- Http Callbacks called before/after each API call
|
public
Inventorus\Http\HttpCallBack
|
#
getHttpCallBack( )
Get HttpCallBack for this controller
Get HttpCallBack for this controller
Returns
Inventorus\Http\HttpCallBack The HttpCallBack object set for this controller
|
public
array
|
#
getExportHistory( )
Returns ids of all export transactions you have created.
Returns ids of all export transactions you have created.
Returns
array
Throws
|
public
array
|
#
getUsersItems( string $steamid, uint $appid, array $contextids = NULL )
Returns user's items from specific application.
Returns user's items from specific application.
Parameters
- $steamid
- Required parameter: SteamID64 of user's profile
- $appid
- Required parameter: ID of target application
- $contextids
- Optional parameter: Array containing numbers representing context ids. By default all contexts are included, but it's recommended to achieve better performance and lower costs.
Returns
array
Throws
|
public
array
|
#
getUsersApps( string $steamid, boolean $includeEmpty = NULL )
Returns applications with inventory items owned by Steam user.
Returns applications with inventory items owned by Steam user.
Parameters
- $steamid
- Required parameter: SteamID64 of user's profile
- $includeEmpty
- Optional parameter: Include user's apps currently containing no items inside his inventory. Default is set to false.
Returns
array
Throws
|
public
mixed
|
#
getExport( string $id )
Returns export transaction.
Returns export transaction.
Parameters
- $id
- Required parameter: ID of requested Import transaction
Returns
mixed
Throws
|
public
string
|
|
public
array
|
#
getImportHistory( )
Returns ids of all import transactions you have created.
Returns ids of all import transactions you have created.
Returns
array
Throws
|
public
mixed
|
#
getImport( string $id )
Returns import transaction.
Returns import transaction.
Parameters
- $id
- Required parameter: ID of requested Import transaction
Returns
mixed
Throws
|
public
array
|
#
listWarehouse( )
Returns all currently owned items.
Returns all currently owned items.
Returns
array
Throws
|
public
string
|
#
createImport( string $body )
Creates a new import.
Parameters
- $body
- $id Required parameter: ID of Import transaction
Returns
string
Throws
|
public
boolean
|
#
cancelImport( $id )
Cancels an unfinished import.
Cancels an unfinished import.
Parameters
Returns
boolean
Throws
|
public
mixed
|
#
getItemDetails( string $id )
Returns item details.
Parameters
- $id
- Required parameter: ID of requested item
Returns
mixed
Throws
|