class vB_Api_Api extends vB_Api

vB_Api_Api

Properties

protected vB_dB_Assertor $dbassertor

Methods

__construct()

Constructor

array
init($clientname, $clientversion, $platformname, $platformversion, $uniqueid, $api_c = 0)

Initializes an API client

Details

at line 30
protected __construct()

Constructor

at line 84
array init($clientname, $clientversion, $platformname, $platformversion, $uniqueid, $api_c = 0)

Initializes an API client

Parameters

$clientname
$clientversion
$platformname
$platformversion
$uniqueid
$api_c

Return Value

array Api information, format: array( apiversion => string apiaccesstoken => string bbtitle => string bburl => string bbactive => int bbclosedreason => string (only set if bbactive = 0) forumhome => string vbulletinversion => string contenttypes => array( content type class => content type id [...] ) features => array( blogenabled => 1 cmsenabled => 1 pmsenabled => int searchesenabled => int groupsenabled => 1 albumsenabled => 0 multitypesearch => 1 visitor_messagingenabled => 1 taggingenabled => int visitor_trackingenabled => 0 paidsubs => int friendsenabled => 0 activitystream => 1 facebookenabled => int calendarenabled => 1 ) permissions => empty array show => array( registerbutton => 1 ) apiclientid => int secret => string (only if API Client ID was specified in the call) )

Exceptions

vB_Exception_Api Throws 'apiclientinfomissing' if any of clientname, clientversion, platformname, platformversion, or uniqueid are missing.