SynthesisRESTClient
Constructor Summary
| Public Constructor | ||
| public |
constructor($q: *, $http: *, RegistrationService: *, SynthConfig: *, CheckError: *, SynthError: *, SynthAuthenticateUser: *) |
|
Member Summary
| Public Members | ||
| public |
$http: * |
|
| public |
$q: * |
|
| public |
checkError: * |
|
| public |
|
|
| public |
|
|
| public |
synthConfig: * |
|
| public |
synthError: * |
|
Method Summary
| Public Methods | ||
| public |
authenticateUser(username: *, password: *, isToken: boolean): * Authenticates a user to the remote server |
|
| public |
getAllowedSites(): * Gets the sites allowed for this user |
|
| public |
getPushMessage(id: *): * Gets a push message from the server |
|
Public Constructors
public constructor($q: *, $http: *, RegistrationService: *, SynthConfig: *, CheckError: *, SynthError: *, SynthAuthenticateUser: *) source
Params:
| Name | Type | Attribute | Description |
| $q | * | ||
| $http | * | ||
| RegistrationService | * | ||
| SynthConfig | * | ||
| CheckError | * | ||
| SynthError | * | ||
| SynthAuthenticateUser | * |
Public Members
public $http: * source
public $q: * source
public checkError: * source
public registrationService: * source
public synthAuthenticateUser: * source
public synthConfig: * source
public synthError: * source
Public Methods
public authenticateUser(username: *, password: *, isToken: boolean): * source
Authenticates a user to the remote server
Params:
| Name | Type | Attribute | Description |
| username | * | ||
| password | * | ||
| isToken | boolean |
|
Return:
| * |
public getAllowedSites(): * source
Gets the sites allowed for this user
Return:
| * | Returns an array of sites the user has available |
public getPushMessage(id: *): * source
Gets a push message from the server
Params:
| Name | Type | Attribute | Description |
| id | * |
Return:
| * |