Core API/Notifications: Difference between revisions
From Zaparoo Wiki
< Core API
Created page with " === Reader === ==== readers.connected ==== A new reader was connected to the server. ==== readers.disconnected ==== A connected reader was disconnected from the server. === Tokens === ==== tokens.launching ==== A new token was added to the launch queue. ==== tokens.active ==== The state of the currently active token has changed. === Media === ==== media.started ==== New media was started on server. ==== media.stopped ==== Media has stopped on server. ==== media..." |
No edit summary |
||
| Line 1: | Line 1: | ||
== | == launching == | ||
==== readers. | == Readers == | ||
=== readers.added === | |||
A new reader was connected to the server. | A new reader was connected to the server. | ||
=== readers.removed === | |||
A connected reader was disconnected from the server. | A connected reader was disconnected from the server. | ||
== Tokens == | |||
=== tokens.added === | |||
=== tokens.removed === | |||
== Media == | |||
=== media.started === | |||
New media was started on server. | New media was started on server. | ||
==== media.stopped | ==== Response ==== | ||
{| class="wikitable" | |||
!Key | |||
!Type | |||
!Required | |||
!Description | |||
|- | |||
|systemId | |||
|string | |||
|Yes | |||
|Internal ID of system associated with media. | |||
|- | |||
|systemName | |||
|string | |||
|Yes | |||
|Display name of system. | |||
|- | |||
|mediaName | |||
|string | |||
|Yes | |||
|Display name of media. | |||
|- | |||
|mediaPath | |||
|string | |||
|Yes | |||
|Path to media file on server. | |||
|} | |||
=== media.stopped === | |||
Media has stopped on server. | Media has stopped on server. | ||
==== media.indexing | ==== Response ==== | ||
Returns <code>null</code>. | |||
=== media.indexing === | |||
The state of the indexing process has changed. | The state of the indexing process has changed. | ||
'''This payload will have significant changes before release.''' | |||
==== Response ==== | |||
{| class="wikitable" | |||
!Key | |||
!Type | |||
!Required | |||
!Description | |||
|- | |||
|indexing | |||
|boolean | |||
|Yes | |||
|True if an index is in progress. | |||
|- | |||
|totalSteps | |||
|number | |||
|Yes | |||
|Total number of "steps" (systems plus database preparation) in index process. | |||
|- | |||
|currentStep | |||
|number | |||
|Yes | |||
|Current step in index. | |||
|- | |||
|currentDesc | |||
|string | |||
|Yes | |||
|Label of current step (in English). | |||
|- | |||
|totalFiles | |||
|number | |||
|Yes | |||
|Total files indexed so far. | |||
|} | |||
Revision as of 13:38, 29 September 2024
launching
Readers
readers.added
A new reader was connected to the server.
readers.removed
A connected reader was disconnected from the server.
Tokens
tokens.added
tokens.removed
Media
media.started
New media was started on server.
Response
| Key | Type | Required | Description |
|---|---|---|---|
| systemId | string | Yes | Internal ID of system associated with media. |
| systemName | string | Yes | Display name of system. |
| mediaName | string | Yes | Display name of media. |
| mediaPath | string | Yes | Path to media file on server. |
media.stopped
Media has stopped on server.
Response
Returns null.
media.indexing
The state of the indexing process has changed.
This payload will have significant changes before release.
Response
| Key | Type | Required | Description |
|---|---|---|---|
| indexing | boolean | Yes | True if an index is in progress. |
| totalSteps | number | Yes | Total number of "steps" (systems plus database preparation) in index process. |
| currentStep | number | Yes | Current step in index. |
| currentDesc | string | Yes | Label of current step (in English). |
| totalFiles | number | Yes | Total files indexed so far. |
