| AUTHENTICATE |
| function authenticate |
Arguments:
| Name |
Required |
Type |
Default |
| un |
Required |
string |
|
| pw |
Required |
string |
|
| admin |
Required |
boolean |
false |
| accountID |
Optional |
numeric |
0 |
| adminAccountID |
Optional |
numeric |
0 |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Authenticates the session |
| Description: |
|
|
|
| DEAUTHENTICATE |
| function deauthenticate |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Deauthenticates the session |
| Description: |
|
|
|
| GENERATEHASH |
| function generateHash |
Arguments:
| Name |
Required |
Type |
Default |
| password |
Required |
string |
|
| salt |
Required |
string |
|
| iterations |
Optional |
numeric |
1024 |
| algorithm |
Optional |
string |
SHA-512 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Generates cryptographic hash |
| Description: |
|
|
|
| GENERATESALT |
| function generateSalt |
Arguments:
| Name |
Required |
Type |
Default |
| size |
Optional |
numeric |
16 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Generates cryptographic salts |
| Description: |
|
|
|
| GETACCOUNTDATA |
| function getAccountData |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Optional |
numeric |
|
| un |
Optional |
string |
|
| uuid |
Optional |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
private |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Retrieves account data |
| Description: |
|
|
|
| GETACCOUNTID |
| function getAccountID |
| Arguments: | none |
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETACCOUNTUSERNAME |
| function getAccountUserName |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETACCOUNTUUID |
| function getAccountUUID |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETADMINACCOUNTID |
| function getAdminAccountID |
| Arguments: | none |
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETFIRSTNAME |
| function getFirstName |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETLASTNAME |
| function getLastName |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPERMISSIONS |
| function getPermissions |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETVARIABLE |
| function getVariable |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Retrieves the specified variable |
| Description: |
|
|
|
| HAS |
| function has |
Arguments:
| Name |
Required |
Type |
Default |
| accessType |
Optional |
string |
|
| accessModifier |
Optional |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Determines authentication access |
| Description: |
|
|
|
| INIT |
| function init |
Arguments:
| Name |
Required |
Type |
Default |
| datasource |
Required |
string |
|
|
| ReturnType: |
authentication
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Initializes the session authentication object |
| Description: |
|
|
|
| REFRESH |
| function refresh |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Refreshes the session |
| Description: |
|
|
|
| SETAUTHENTICATIONDATA |
| function setAuthenticationData |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
query |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
private |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Sets account authentication data |
| Description: |
|
|
|
| SETSSOTOKENBYAJAX |
| function setSSOTokenByAJAX |
Arguments:
| Name |
Required |
Type |
Default |
| newToken |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Sets session flag. Returns whether token update was successful. |
| Description: |
|
|
|