Preparing search index...
The search index is not available
@placeos/ts-client
@placeos/ts-client
@placeos/ts-client
Enumerations
AuthType
EncryptionLevel
MediaAnimation
PlaceDriverRole
PlaceErrorCodes
PlaceLogLevel
PlaceRepositoryType
TriggerConditionOperator
TriggerTimeConditionType
TriggerWebhookType
Classes
MockPlaceWebsocketModule
MockPlaceWebsocketSystem
PlaceAlert
PlaceAlertDashboard
PlaceApplication
PlaceAsset
PlaceAssetCategory
PlaceAssetPurchaseOrder
PlaceAssetType
PlaceCluster
PlaceDomain
PlaceDriver
PlaceEdge
PlaceLDAPSource
PlaceMetadata
PlaceModule
PlaceModuleBinding
PlaceMQTTBroker
PlaceOAuthSource
PlaceProcess
PlaceRepository
PlaceResource
PlaceSAMLSource
PlaceSettings
PlaceShortUrl
PlaceStorage
PlaceSystem
PlaceSystemBinding
PlaceTrigger
PlaceUser
PlaceVariableBinding
PlaceZone
PlaceZoneMetadata
SignageMedia
SignagePlaylist
SignagePlaylistMedia
Survey
SurveyAnswer
SurveyInvitation
SurveyQuestion
Interfaces
AnswerQueryOptions
GitCommitDetails
HttpError
HttpJsonOptions
HttpOptions
InvitationQueryOptions
InvitationShowOptions
MockHttpRequest
MockHttpRequestHandler
MockHttpRequestHandlerOptions
PlaceAlertDashboardQueryOptions
PlaceAlertQueryOptions
PlaceAlertShowOptions
PlaceApplicationQueryOptions
PlaceAssetCategoryQueryOptions
PlaceAssetPurchaseOrderQueryOptions
PlaceAssetQueryOptions
PlaceAssetTypeQueryOptions
PlaceAuthOptions
PlaceAuthority
PlaceAuthSourceQueryOptions
PlaceClusterQueryOptions
PlaceClusterShowOptions
PlaceClusterTerminateOptions
PlaceClusterVersions
PlaceCommandRequest
PlaceCommandRequestMetadata
PlaceDebugEvent
PlaceDriverDetails
PlaceDriverQueryOptions
PlaceDriverShowOptions
PlaceExecRequestOptions
PlaceGuestParticipant
PlaceKickReason
PlaceMetadataDeleteOptions
PlaceMetadataHistoryOptions
PlaceMetadataOptions
PlaceModuleFunction
PlaceModuleFunctionMap
PlaceModulePingOptions
PlaceModuleQueryOptions
PlaceModuleShowOptions
PlaceQrCodeOptions
PlaceRemoteRepositoryCommitsQuery
PlaceRemoteRepositoryQuery
PlaceRepositoryCommit
PlaceRepositoryCommitQuery
PlaceRepositoryDetailsQuery
PlaceRepositoryFoldersQuery
PlaceRepositoryPullQuery
PlaceRepositoryQueryOptions
PlaceRequestOptions
PlaceResourceQueryOptions
PlaceResponse
PlaceSamlRequestAttribute
PlaceSettingsHistoryOptions
PlaceSettingsQueryOptions
PlaceShortUrlPngQrOptions
PlaceShortUrlQueryOptions
PlaceStorageQueryOptions
PlaceSystemControlOptions
PlaceSystemMetadataOptions
PlaceSystemShowOptions
PlaceSystemsQueryOptions
PlaceSystemStartStopOptions
PlaceSystemsWithEmailsOptions
PlaceSystemTriggerShowOptions
PlaceSystemTriggersQueryOptions
PlaceSystemUpdateOptions
PlaceTokenResponse
PlaceTriggerQueryOptions
PlaceTriggerShowOptions
PlaceUserDeleteOptions
PlaceUserGroupsOptions
PlaceUserMetadataOptions
PlaceUserMetadataSearchOptions
PlaceUserQueryOptions
PlaceUserShowOptions
PlaceWebrtcMember
PlaceWebrtcRoomDetails
PlaceWebrtcRoomsQueryOptions
PlaceWebsocketOptions
PlaceZoneMetadataOptions
PlaceZoneMetadataQueryOptions
PlaceZoneQueryOptions
PlaceZoneShowOptions
QuestionQueryOptions
QuestionShowOptions
SignageMediaQueryOptions
SignageMetrics
SignagePlaylistQueryOptions
SignagePlaylistRevisionsOptions
SimpleNetworkError
SurveyPage
SurveyQueryOptions
SurveyShowOptions
TriggerActions
TriggerAtTimeCondition
TriggerComparison
TriggerConditions
TriggerCronTimeCondition
TriggerFunction
TriggerMailer
TriggerStatusVariable
TriggerWebhook
WorktimePreference
Type Aliases
ExecuteArgs
HttpResponse
HttpResponseType
MediaOrientation
PlaceCommand
QrCodeFormat
QueryResponse
StorageType
TriggerConditionConstant
TriggerConditionValue
TriggerTimeCondition
Variables
debug_events
Functions
addAlert
addAlertDashboard
addAnswer
addApplication
addAsset
addAssetCategory
addAssetPurchaseOrder
addAssets
addAssetType
addBroker
addDomain
addDriver
addEdge
addInvitation
addLDAPSource
addMetadata
addModule
addOAuthSource
addQuestion
addRepository
addSAMLSource
addSettings
addShortUrl
addSignageMedia
addSignagePlaylist
addStorage
addSurvey
addSystem
addSystemModule
addSystemTrigger
addTrigger
addUser
addZone
apiEndpoint
apiKey
approveSignagePlaylist
authorise
authority
bind
clientId
clusterRebalance
clusterVersions
connectionState
currentUser
currentUserResourceToken
debug
del
deregisterMockEndpoint
deregisterSystem
driverReadme
edgeControlUrl
execute
executeOnModule
executeOnSystem
executeOnZone
functionList
generateQrCode
get
getFragments
getModule
getShortUrlQrCodeSvg
getSystem
hasToken
host
httpRoute
humanReadableByteCount
ignore
invalidateToken
is_connected
isDriverCompiled
isFixedDevice
isMobileSafari
isMock
isNestedFrame
isOnline
isSecure
isTrusted
lastRequestTotal
listChildMetadata
listDashboardAlerts
listen
listenForToken
listInterfaceRepositories
listMetadata
listMetadataHistory
listRemoteRepositoryBranches
listRemoteRepositoryCommits
listRemoteRepositoryDefaultBranch
listRepositoryBranches
listRepositoryCommits
listRepositoryDefaultBranch
listRepositoryDriverDetails
listRepositoryDrivers
listRepositoryFolders
listSignagePlaylistMedia
listSignagePlaylistMediaRevisions
listSystemTriggers
listSystemZones
listTriggerInstances
listZoneTags
listZoneTriggers
loadModule
logout
lookupDomainByEmail
lookupModuleState
lookupSystemModuleState
mediaThumbnail
mockSystem
moduleRuntimeError
moduleSettings
moduleState
onlineState
patch
post
pullRepositoryChanges
put
qrCodeUrl
queryAlertDashboards
queryAlerts
queryAnswers
queryApplications
queryAssetCategories
queryAssetPurchaseOrders
queryAssets
queryAssetTypes
queryBrokers
queryClusters
queryDomains
queryDrivers
queryEdges
queryInvitations
queryLDAPSources
queryModules
queryOAuthSources
queryProcesses
queryQuestions
queryRepositories
querySAMLSources
querySettings
queryShortUrls
querySignageMedia
querySignagePlaylists
queryStorages
querySurveys
querySystems
querySystemsWithEmails
queryTriggers
queryUserGroups
queryUsers
queryWebrtcRooms
queryZones
recompileDriver
redirectUri
refreshAuthority
refreshToken
registerMockEndpoint
registerSystem
reloadDriver
removeAlert
removeAlertDashboard
removeApplication
removeAsset
removeAssetCategory
removeAssetPurchaseOrder
removeAssets
removeAssetType
removeBroker
removeDomain
removeDriver
removeEdge
removeInvitation
removeLDAPSource
removeMetadata
removeModule
removeOAuthSource
removeQuestion
removeRepository
removeSAMLSource
removeSettings
removeShortUrl
removeSignageMedia
removeSignagePlaylist
removeStorage
removeSurvey
removeSystem
removeSystemModule
removeSystemTrigger
removeTrigger
removeUser
removeUserResourceToken
removeZone
requestTotal
responseHeaders
retrieveEdgeToken
reviveUser
searchUserMetadata
setAPI_Key
setMockNotFoundHandler
settingsHistory
setToken
setup
shortUrlQrCodePngUrl
shortUrlRedirectUrl
showAlert
showAlertDashboard
showApplication
showAsset
showAssetCategory
showAssetPurchaseOrder
showAssetType
showBroker
showCluster
showDomain
showDriver
showEdge
showInvitation
showLDAPSource
showMetadata
showModule
showOAuthSource
showQuestion
showRepository
showSAMLSource
showSettings
showShortUrl
showSignage
showSignageMedia
showSignageMetrics
showSignagePlaylist
showStorage
showSurvey
showSystem
showSystemTrigger
showTrigger
showUser
showWebrtcRoom
showZone
simplifiedTime
startModule
startSystem
status
stopModule
stopSystem
systemControlUrl
systemMetadata
systemModuleState
systemSettings
terminateProcess
token
unbind
updateAlert
updateAlertDashboard
updateApplication
updateAsset
updateAssetCategory
updateAssetPurchaseOrder
updateAssets
updateAssetType
updateBroker
updateDomain
updateDriver
updateEdge
updateInvitation
updateLDAPSource
updateMetadata
updateModule
updateOAuthSource
updateQuestion
updateRepository
updateSAMLSource
updateSettings
updateShortUrl
updateSignageMedia
updateSignagePlaylist
updateSignagePlaylistMedia
updateStorage
updateSurvey
updateSystem
updateSystemTrigger
updateTrigger
updateUser
updateZone
userMetadata
userResourceToken
value
webrtcGuestEntry
webrtcGuestExit
webrtcKickUser
webrtcSessionMembers
webrtcSignallerUrl
webrtcTransferUser
websocketRoute
zoneMetadata
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Enumerations
Auth
Type
Encryption
Level
Media
Animation
Place
Driver
Role
Place
Error
Codes
Place
Log
Level
Place
Repository
Type
Trigger
Condition
Operator
Trigger
Time
Condition
Type
Trigger
Webhook
Type
Classes
Mock
Place
Websocket
Module
Mock
Place
Websocket
System
Place
Alert
Place
Alert
Dashboard
Place
Application
Place
Asset
Place
Asset
Category
Place
Asset
Purchase
Order
Place
Asset
Type
Place
Cluster
Place
Domain
Place
Driver
Place
Edge
PlaceLDAPSource
Place
Metadata
Place
Module
Place
Module
Binding
PlaceMQTTBroker
PlaceOAuth
Source
Place
Process
Place
Repository
Place
Resource
PlaceSAMLSource
Place
Settings
Place
Short
Url
Place
Storage
Place
System
Place
System
Binding
Place
Trigger
Place
User
Place
Variable
Binding
Place
Zone
Place
Zone
Metadata
Signage
Media
Signage
Playlist
Signage
Playlist
Media
Survey
Survey
Answer
Survey
Invitation
Survey
Question
Interfaces
Answer
Query
Options
Git
Commit
Details
Http
Error
Http
Json
Options
Http
Options
Invitation
Query
Options
Invitation
Show
Options
Mock
Http
Request
Mock
Http
Request
Handler
Mock
Http
Request
Handler
Options
Place
Alert
Dashboard
Query
Options
Place
Alert
Query
Options
Place
Alert
Show
Options
Place
Application
Query
Options
Place
Asset
Category
Query
Options
Place
Asset
Purchase
Order
Query
Options
Place
Asset
Query
Options
Place
Asset
Type
Query
Options
Place
Auth
Options
Place
Authority
Place
Auth
Source
Query
Options
Place
Cluster
Query
Options
Place
Cluster
Show
Options
Place
Cluster
Terminate
Options
Place
Cluster
Versions
Place
Command
Request
Place
Command
Request
Metadata
Place
Debug
Event
Place
Driver
Details
Place
Driver
Query
Options
Place
Driver
Show
Options
Place
Exec
Request
Options
Place
Guest
Participant
Place
Kick
Reason
Place
Metadata
Delete
Options
Place
Metadata
History
Options
Place
Metadata
Options
Place
Module
Function
Place
Module
Function
Map
Place
Module
Ping
Options
Place
Module
Query
Options
Place
Module
Show
Options
Place
Qr
Code
Options
Place
Remote
Repository
Commits
Query
Place
Remote
Repository
Query
Place
Repository
Commit
Place
Repository
Commit
Query
Place
Repository
Details
Query
Place
Repository
Folders
Query
Place
Repository
Pull
Query
Place
Repository
Query
Options
Place
Request
Options
Place
Resource
Query
Options
Place
Response
Place
Saml
Request
Attribute
Place
Settings
History
Options
Place
Settings
Query
Options
Place
Short
Url
Png
Qr
Options
Place
Short
Url
Query
Options
Place
Storage
Query
Options
Place
System
Control
Options
Place
System
Metadata
Options
Place
System
Show
Options
Place
Systems
Query
Options
Place
System
Start
Stop
Options
Place
Systems
With
Emails
Options
Place
System
Trigger
Show
Options
Place
System
Triggers
Query
Options
Place
System
Update
Options
Place
Token
Response
Place
Trigger
Query
Options
Place
Trigger
Show
Options
Place
User
Delete
Options
Place
User
Groups
Options
Place
User
Metadata
Options
Place
User
Metadata
Search
Options
Place
User
Query
Options
Place
User
Show
Options
Place
Webrtc
Member
Place
Webrtc
Room
Details
Place
Webrtc
Rooms
Query
Options
Place
Websocket
Options
Place
Zone
Metadata
Options
Place
Zone
Metadata
Query
Options
Place
Zone
Query
Options
Place
Zone
Show
Options
Question
Query
Options
Question
Show
Options
Signage
Media
Query
Options
Signage
Metrics
Signage
Playlist
Query
Options
Signage
Playlist
Revisions
Options
Simple
Network
Error
Survey
Page
Survey
Query
Options
Survey
Show
Options
Trigger
Actions
Trigger
At
Time
Condition
Trigger
Comparison
Trigger
Conditions
Trigger
Cron
Time
Condition
Trigger
Function
Trigger
Mailer
Trigger
Status
Variable
Trigger
Webhook
Worktime
Preference
Type Aliases
Execute
Args
Http
Response
Http
Response
Type
Media
Orientation
Place
Command
Qr
Code
Format
Query
Response
Storage
Type
Trigger
Condition
Constant
Trigger
Condition
Value
Trigger
Time
Condition
Variables
debug_
events
Functions
add
Alert
add
Alert
Dashboard
add
Answer
add
Application
add
Asset
add
Asset
Category
add
Asset
Purchase
Order
add
Assets
add
Asset
Type
add
Broker
add
Domain
add
Driver
add
Edge
add
Invitation
addLDAPSource
add
Metadata
add
Module
addOAuth
Source
add
Question
add
Repository
addSAMLSource
add
Settings
add
Short
Url
add
Signage
Media
add
Signage
Playlist
add
Storage
add
Survey
add
System
add
System
Module
add
System
Trigger
add
Trigger
add
User
add
Zone
api
Endpoint
api
Key
approve
Signage
Playlist
authorise
authority
bind
client
Id
cluster
Rebalance
cluster
Versions
connection
State
current
User
current
User
Resource
Token
debug
del
deregister
Mock
Endpoint
deregister
System
driver
Readme
edge
Control
Url
execute
execute
On
Module
execute
On
System
execute
On
Zone
function
List
generate
Qr
Code
get
get
Fragments
get
Module
get
Short
Url
Qr
Code
Svg
get
System
has
Token
host
http
Route
human
Readable
Byte
Count
ignore
invalidate
Token
is_
connected
is
Driver
Compiled
is
Fixed
Device
is
Mobile
Safari
is
Mock
is
Nested
Frame
is
Online
is
Secure
is
Trusted
last
Request
Total
list
Child
Metadata
list
Dashboard
Alerts
listen
listen
For
Token
list
Interface
Repositories
list
Metadata
list
Metadata
History
list
Remote
Repository
Branches
list
Remote
Repository
Commits
list
Remote
Repository
Default
Branch
list
Repository
Branches
list
Repository
Commits
list
Repository
Default
Branch
list
Repository
Driver
Details
list
Repository
Drivers
list
Repository
Folders
list
Signage
Playlist
Media
list
Signage
Playlist
Media
Revisions
list
System
Triggers
list
System
Zones
list
Trigger
Instances
list
Zone
Tags
list
Zone
Triggers
load
Module
logout
lookup
Domain
By
Email
lookup
Module
State
lookup
System
Module
State
media
Thumbnail
mock
System
module
Runtime
Error
module
Settings
module
State
online
State
patch
post
pull
Repository
Changes
put
qr
Code
Url
query
Alert
Dashboards
query
Alerts
query
Answers
query
Applications
query
Asset
Categories
query
Asset
Purchase
Orders
query
Assets
query
Asset
Types
query
Brokers
query
Clusters
query
Domains
query
Drivers
query
Edges
query
Invitations
queryLDAPSources
query
Modules
queryOAuth
Sources
query
Processes
query
Questions
query
Repositories
querySAMLSources
query
Settings
query
Short
Urls
query
Signage
Media
query
Signage
Playlists
query
Storages
query
Surveys
query
Systems
query
Systems
With
Emails
query
Triggers
query
User
Groups
query
Users
query
Webrtc
Rooms
query
Zones
recompile
Driver
redirect
Uri
refresh
Authority
refresh
Token
register
Mock
Endpoint
register
System
reload
Driver
remove
Alert
remove
Alert
Dashboard
remove
Application
remove
Asset
remove
Asset
Category
remove
Asset
Purchase
Order
remove
Assets
remove
Asset
Type
remove
Broker
remove
Domain
remove
Driver
remove
Edge
remove
Invitation
removeLDAPSource
remove
Metadata
remove
Module
removeOAuth
Source
remove
Question
remove
Repository
removeSAMLSource
remove
Settings
remove
Short
Url
remove
Signage
Media
remove
Signage
Playlist
remove
Storage
remove
Survey
remove
System
remove
System
Module
remove
System
Trigger
remove
Trigger
remove
User
remove
User
Resource
Token
remove
Zone
request
Total
response
Headers
retrieve
Edge
Token
revive
User
search
User
Metadata
setAPI_
Key
set
Mock
Not
Found
Handler
settings
History
set
Token
setup
short
Url
Qr
Code
Png
Url
short
Url
Redirect
Url
show
Alert
show
Alert
Dashboard
show
Application
show
Asset
show
Asset
Category
show
Asset
Purchase
Order
show
Asset
Type
show
Broker
show
Cluster
show
Domain
show
Driver
show
Edge
show
Invitation
showLDAPSource
show
Metadata
show
Module
showOAuth
Source
show
Question
show
Repository
showSAMLSource
show
Settings
show
Short
Url
show
Signage
show
Signage
Media
show
Signage
Metrics
show
Signage
Playlist
show
Storage
show
Survey
show
System
show
System
Trigger
show
Trigger
show
User
show
Webrtc
Room
show
Zone
simplified
Time
start
Module
start
System
status
stop
Module
stop
System
system
Control
Url
system
Metadata
system
Module
State
system
Settings
terminate
Process
token
unbind
update
Alert
update
Alert
Dashboard
update
Application
update
Asset
update
Asset
Category
update
Asset
Purchase
Order
update
Assets
update
Asset
Type
update
Broker
update
Domain
update
Driver
update
Edge
update
Invitation
updateLDAPSource
update
Metadata
update
Module
updateOAuth
Source
update
Question
update
Repository
updateSAMLSource
update
Settings
update
Short
Url
update
Signage
Media
update
Signage
Playlist
update
Signage
Playlist
Media
update
Storage
update
Survey
update
System
update
System
Trigger
update
Trigger
update
User
update
Zone
user
Metadata
user
Resource
Token
value
webrtc
Guest
Entry
webrtc
Guest
Exit
webrtc
Kick
User
webrtc
Session
Members
webrtc
Signaller
Url
webrtc
Transfer
User
websocket
Route
zone
Metadata
@placeos/ts-client
Loading...