Core API/Methods: Difference between revisions

← Older edit Newer edit →

VisualWikitext

Revision as of 08:59, 24 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

Example

settings.update

Update one or more settings in-memory and save changes to disk.

Parameters

Result

Example

Mappings

mappings

List all mappings.

Returns a list of all active and inactive mappings entries stored on server.

Parameters

Result

Example

mappings.new

Create a new mapping.

Parameters

Result

Example

mappings.delete

Delete an existing mapping.

Parameters

Result

Example

mappings.update

Change an existing mapping.

Parameters

Result

Example

Readers

readers

List all currently connected readers.

Parameters

Result

Example

readers.write

Attempt to write given text to the first available write-capable reader, if possible.

@@ Line 199: / Line 199: @@
 This method has no parameters.
-===== Result =====
+==== Result ====
 {| class="wikitable"
 !Key
@@ Line 265: / Line 265: @@
 |}
-====== API config ======
+==== Example ====
 === settings.update ===
 Update one or more settings in-memory and save changes to disk.
+==== Parameters ====
+==== Result ====
+==== Example ====
 === Mappings ===
@@ Line 277: / Line 283: @@
 Returns a list of all active and inactive mappings entries stored on server.
-===== Parameters =====
+==== Parameters ====
+==== Result ====
-===== Results =====
+==== Example ====
 === mappings.new ===
 Create a new mapping.
-===== Parameters =====
+==== Parameters ====
-===== Results =====
+==== Result ====
+==== Example ====
 === mappings.delete ===
 Delete an existing mapping.
-===== Parameters =====
+==== Parameters ====
-===== Results =====
+==== Result ====
+==== Example ====
 === mappings.update ===
 Change an existing mapping.
-===== Parameters =====
+==== Parameters ====
-===== Results =====
+==== Result ====
+==== Example ====
 == Readers ==
@@ Line 307: / Line 321: @@
 List all currently connected readers.
-===== Parameters =====
+==== Parameters ====
-===== Results =====
+==== Result ====
+==== Example ====
 === readers.write ===
 Attempt to write given text to the first available write-capable reader, if possible.
-===== Parameters =====
+==== Parameters ====
-===== Results =====
+==== Result ====
+==== Example ====
 == Clients ==
@@ Line 323: / Line 341: @@
 === clients ===
 List all clients (including disconnected) and associated data.
+==== Parameters ====
+==== Result ====
+==== Example ====
 === clients.new ===
 Create a new client with a newly generated ID and secret.
+==== Parameters ====
+==== Result ====
+==== Example ====
 === clients.delete ===
 Delete an existing client.
+==== Parameters ====
+==== Result ====
+==== Example ====
 == Service ==
@@ Line 334: / Line 370: @@
 === version ===
 Return server's current version and platform.
+==== Parameters ====
+==== Result ====
+==== Example ====