Core API/Methods: Difference between revisions
No edit summary |
No edit summary |
||
| Line 75: | Line 75: | ||
Query the media database and return all matching indexed media. | Query the media database and return all matching indexed media. | ||
==== Parameters ==== | |||
This request accepts the following parameters object: | This request accepts the following parameters object: | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 97: | Line 98: | ||
|Max number of results to return. Default is 250. | |Max number of results to return. Default is 250. | ||
|} | |} | ||
==== Result ==== | |||
And a response with the following results object: | And a response with the following results object: | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 160: | Line 163: | ||
|Category of system. This field is not yet formalised. | |Category of system. This field is not yet formalised. | ||
|} | |} | ||
==== Example ==== | |||
=== media.index === | === media.index === | ||
Start a new media database index. | Start a new media database index. | ||
This method does not block and wait for the index to complete. It will return a response immediately and start in the background. <code>media.indexing</code> notifications will be sent to show progress of current indexing process. | |||
==== Parameters ==== | |||
This method can, optionally, take a list of strings of system IDs to restrict the index to just those systems. | This method can, optionally, take a list of strings of system IDs to restrict the index to just those systems. | ||
==== Result ==== | |||
==== Example ==== | |||
=== systems === | === systems === | ||
List all currently indexed systems. | List all currently indexed systems. | ||
This method has no parameters | ==== Parameters ==== | ||
This method has no parameters. | |||
==== Result ==== | |||
Returns a response results object of a list of [[TapTo API#System object|System objects]]. | |||
==== Example ==== | |||
== Settings == | == Settings == | ||
| Line 183: | Line 199: | ||
This method has no parameters. | This method has no parameters. | ||
===== | ===== Result ===== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Key | !Key | ||
Revision as of 14:49, 23 September 2024
Methods are used to execute actions and request data back from the API.
Launching
launch
Emulate the scanning of a token.
Parameters
This method accepts two types of parameters:
- A single string, in which case the string will be treated as the token text.
- Or an object with the following keys:
| Key | Type | Required | Description |
|---|---|---|---|
| type | string | No | An internal category of the type of token being scanned. Not currently in use outside of logging. |
| uid | string | No* | The UID of the token being scanner. For example, the UID of an NFC tag. Used for matching mappings. |
| text | string | No* | The main text to be processed from a scan, should contain TapScript. |
| data | string | No* | The raw data read from a token, converted to a hexadecimal string. Used in mappings and detection of NFC toys such as Amiibos and Lego Dimensions. |
These parameters allow emulating a token exactly as it would be read directly from an attached reader on the server. A request's parameters must contain at least a populated uid, text or data value.
Result
This method returns null on success.
Currently, it is not reported if the launched TapScript encounters an error during launching.
Example
stop
Kill any active launcher, if possible.
Parameters
None.
Result
This method returns null on success.
Currently, it is not reported if a process was killed or not.
Example
history
Returns a list of the last recorded token launches.
Parameters
None.
Result
Example
Media
media.search
Query the media database and return all matching indexed media.
Parameters
This request accepts the following parameters object:
| Key | Type | Required | Description |
|---|---|---|---|
| query | string | Yes | Case-insensitive search by filename. By default, query is split by white space and results are found which contain every word. |
| system | string[] | No | Case-sensitive list of system IDs to restrict search to. A missing key or empty list will search all systems. |
| maxResults | number | No | Max number of results to return. Default is 250. |
Result
And a response with the following results object:
| Key | Type | Required | Description |
|---|---|---|---|
| results | Media[] | Yes | A list of all search results from the given query. |
| total | number | Yes | Total number of search results. |
Media object
| Key | Type | Required | Description |
|---|---|---|---|
| system | System | Yes | System which the media has been indexed under. |
| name | string | Yes | A human-readable version of the result's filename without a file extension. |
| path | string | Yes | Path to the media file. If possible, this path will be compressed into the <system>/<path> launch format.
|
System object
| Key | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Internal system ID for this system. |
| name | string | Yes | Display name of the system. |
| category | string | Yes | Category of system. This field is not yet formalised. |
Example
media.index
Start a new media database index.
This method does not block and wait for the index to complete. It will return a response immediately and start in the background. media.indexing notifications will be sent to show progress of current indexing process.
Parameters
This method can, optionally, take a list of strings of system IDs to restrict the index to just those systems.
Result
Example
systems
List all currently indexed systems.
Parameters
This method has no parameters.
Result
Returns a response results object of a list of System objects.
Example
Settings
settings
List currently set configuration settings.
This method will list values set in the Config File. Values may be hidden which are not appropriate to be read remotely.
Parameters
This method has no parameters.
Result
| Key | Type | Required | Description |
|---|---|---|---|
| reader | string[] | Yes | A list of manually configured reader driver connection strings. See reader. |
| audioFeedback | boolean | Yes | |
| detectReaders | boolean | Yes | |
| insertMode | boolean | Yes | |
| insertModeBlocklist | string[] | Yes | |
| insertModeExitDelay | number | Yes | |
| consoleLogging | boolean | Yes | |
| debug | boolean | Yes | See debug. |
| systems | Systems config | Yes | The systems section of the config file. |
Systems config
| Key | Type | Required | Description |
|---|---|---|---|
| rootFolder | string[] | Yes |
API config
settings.update
Update one or more settings in-memory and save changes to disk.
Mappings
mappings
List all mappings.
Returns a list of all active and inactive mappings entries stored on server.
Parameters
Results
mappings.new
Create a new mapping.
Parameters
Results
mappings.delete
Delete an existing mapping.
Parameters
Results
mappings.update
Change an existing mapping.
Parameters
Results
Readers
readers
List all currently connected readers.
Parameters
Results
readers.write
Attempt to write given text to the first available write-capable reader, if possible.
Parameters
Results
Clients
Clients can only be managed through the API via a device-local connection.
clients
List all clients (including disconnected) and associated data.
clients.new
Create a new client with a newly generated ID and secret.
clients.delete
Delete an existing client.
Service
version
Return server's current version and platform.
