Classes
Methods
# getMaps(token, versionopt) → {Array.<UserService~Map>}
Retrieves maps available for a user.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
token |
string | The user's authentication token. |
||
version |
string | null |
<optional> |
null | The expected map version. If omitted, all maps are returned. Should be a value from MapVersion |
- An array of map instances.
# getUserInfo(username, password, mapVersionopt, applicationopt) → {UserService~UserInfo}
Retrieves user information based on the provided credentials. Additionally, it returns the list of maps associated with the user.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
username |
string | The username of the user. |
||
password |
string | The user's password. |
||
mapVersion |
string | null |
<optional> |
null | The map version to request. If not specified, all maps are returned. Should be a value from MapVersion |
application |
string |
<optional> |
"map-control" | The application requesting access. |
- The user information.
Type Definitions
# Map
Object with the map data received by the api
Properties:
Name | Type | Description |
---|---|---|
id |
string | identifier for map |
name |
string | name for the map |
version |
string | version for the map. Should be a value from MapVersion |
# UserInfo
Object with the user data received by the api
Properties:
Name | Type | Description |
---|---|---|
username |
string | Triggered after the map is moved. |
token |
string | key to initialize and authorize this user |
maps |
Array.<UserService~Map> | list of maps allowed for this user |