Interface SignagePluginQueryOptions

Allowable query parameters for signage plugins index endpoint

interface SignagePluginQueryOptions {
    _poll?: boolean;
    cache?: number;
    enabled?: boolean;
    fields?: string;
    limit?: number;
    offset?: number;
    plugin_type?: SignagePluginType;
    q?: string;
    ref?: string;
}

Hierarchy (View Summary)

Properties

_poll? cache? enabled? fields? limit? offset? plugin_type? q? ref?

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

Optionalcache

cache?: number

Number of milliseconds to cache the query response

Optionalenabled

enabled?: boolean

Only return plugins that are enabled

Optionalfields

fields?: string

Deprecated

Ignored by the server since PlaceOS moved search to PostgreSQL (PPT-2644)

Optionallimit

limit?: number

Number of results to return. Defaults to 20. Max 10000

Optionaloffset

offset?: number

Offset of the results to return. Max 1000000

Optionalplugin_type

plugin_type?: SignagePluginType

Only return plugins of this type

Optionalq

q?: string

Free-text search filter. Words match as prefixes against the resource's searchable fields (PostgreSQL full-text search); all words must match.

Optionalref

ref?: string

Deprecated

Ignored by the server; pagination follows the Link header's offset

Settings

Member Visibility

On This Page

Properties