Detect the best device driver form the browser
Detects the operating system and returns its id display name and group membership (as in devices.php)
API Tags:
Return: | indexed by 'id', 'display', 'group' |
Access: | public |
void deviceInfo(
$device,
$prof_id
)
|
|
Parameters:
API Tags:
binary downloadInstaller(
string
$device, int
$prof_id, [
$generated_for = 'user']
)
|
|
Generate and send the installer
Parameters:
string |
$device: |
identifier as in devices.php |
int |
$prof_id: |
profile identifier |
|
$generated_for: |
|
API Tags:
Return: | installerFile |
Access: | public |
array generateInstaller(
string
$device, int
$prof_id, [
$generated_for = "user"]
)
|
|
Prepare the device module environment and send back the link
This method creates a device module instance via the DeviceFactory call, then sets up the device module environment for the specific profile by calling DeviceConfig::setup() method and finally, called the devide writeInstaller meethod passing the returned path name.
Parameters:
string |
$device: |
identifier as in devices.php |
int |
$prof_id: |
profile identifier |
|
$generated_for: |
|
API Tags:
Return: | array with the following fields: profile - the profile identifier; device - the device identifier; link - the path name of the resulting installer mime - the mimetype of the installer |
Access: | public |
string JSON_generateInstaller(
string
$device, int
$prof_id
)
|
|
Call installer generation and return the link
Parameters:
string |
$device: |
identifier as in devices.php |
int |
$prof_id: |
profile identifier |
API Tags:
Return: | JSON encoded data |
Access: | public |
string JSON_listCountries(
)
|
|
Return the list of countiers with configured IdPs
API Tags:
Return: | JSON encoded data |
Access: | public |
string JSON_listDevices(
int
$profile_id
)
|
|
Return the list of devices available for the given profile
Parameters:
int |
$profile_id: |
the Profile identifier |
API Tags:
Return: | JSON encoded data |
Access: | public |
string JSON_listIdentityProviders(
$country, int
$idp_id
)
|
|
Return the list of IdPs in a given country
Parameters:
int |
$idp_id: |
the IdP identifier |
|
$country: |
|
API Tags:
Return: | JSON encoded data |
Access: | public |
string JSON_listIdentityProvidersForDisco(
)
|
|
return the list of all active IdPs
The IdP list is formatted for DiscoJuice
API Tags:
Return: | JSON encoded data |
Access: | public |
void JSON_listLanguages(
)
|
|
Return the list of supported languages.
API Tags:
string JSON_listProfiles(
int
$idp_id, [
$sort = 0]
)
|
|
Produce a list of profiles available for a given IdP
Parameters:
int |
$idp_id: |
the IdP identifier |
|
$sort: |
|
API Tags:
Return: | JSON encoded data |
Access: | public |
string JSON_orderIdentityProviders(
$country, int
$idp_id
)
|
|
Return the list of IdPs in a given country ordered with respect to the user location
Parameters:
int |
$idp_id: |
the IdP identifier |
|
$country: |
|
API Tags:
Return: | JSON encoded data |
Access: | public |
string JSON_profileAttributes(
$prof_id
)
|
|
Produce support data prepared within GUI::profileAttributes()
Parameters:
API Tags:
Return: | JSON encoded data |
Access: | public |
void listDevices(
[
$show_hidden = 0]
)
|
|
interface to Devices::listDevices()
Parameters:
API Tags:
array orderIdentityProviders(
$country, array
$L
)
|
|
Order active identity providers according to their distance and name
Parameters:
array |
$L: |
- current location |
|
$country: |
|
API Tags:
Return: | - list of arrays ('id', 'name'); |
Access: | public |
array profileAttributes(
int
$prof_id
)
|
|
Prepare the support data for a given profile
Parameters:
int |
$prof_id: |
profile identifier |
API Tags:
Return: | array with the following fields: - local_email
- local_phone
- local_url
- description
- devices - an array of device names and their statuses (for a given profile)
|
Access: | public |
void return_json(
$data, [
$status = 1]
)
|
|
Parameters:
API Tags:
void sendLogo(
int
$idp_id, [int
$disco = FALSE]
)
|
|
Get and prepare logo file
When called for DiscoJuice, first check if file cache exists If not then generate the file and save it in the cache
Parameters:
int |
$idp_id: |
IdP identifier |
int |
$disco: |
flag turning on image generation for DiscoJuice |
API Tags: