ICommandOptions

[ Type ]

Version 1.8

export type ICommandOptions = 
'Add' |
'Config' |
'ForceSingleWrite' |
'Offline' |
'Poll' |
'Replace' |
'SendErrorMessage' |
'SendWriteValue' |
'UniqueHash' |
'Extension1' | 
'Extension2' | 
'Extension3' | 
'Extension4';

Version 1.10.1060.0

export type ICommandOptions = 
'Add' |
'Config' |
'Delete' |
'ForceSingleWrite' |
'Offline' |
'Poll' |
'Replace' |
'SendErrorMessage' |
'SendWriteValue' |
'UniqueHash' |
'Extension1' | 
'Extension2' | 
'Extension3' | 
'Extension4';

Version 1.12

export type ICommandOptions = 
'Add' |
'Check' |
'Config' |
'Delete' |
'ForceSingleWrite' |
'Import' |
'Offline' |
'PagingHandled' |
'Poll' |
'Replace' |
'SendErrorMessage' |
'SendWriteValue' |
'Transaction' |
'ValidateRead' |
'UniqueHash' |
'ProcessTimingAsTimespan' |
'Extension1' | 
'Extension2' | 
'Extension3' | 
'Extension4';

Keywords:

Name	Description
Add	Only valid for Config values: When writing to vectors, the new values are added instead of overwriting the old values.
Check	Only valid for Config values: Does not read the values, but only checks the access rights. Deprecated: Will be removed in a future version.
Config	Deprecated: Will be removed in a future version.
Delete Available from version 1.10.1060.0	Only valid for Config values: Deletes supplied vector/map entries.
ForceSingleWrite	This option has been replaced by UniqueHash and should not be used for new projects. Will be removed in a future version.
Import
Offline	New values are not passed on to the extension.
PagingHandled	Set by the server only if paging was used.
Poll	Only valid for subscriptions: Returns a value for each tick, even if it has not changed.
Replace
SendErrorMessage	In addition, plain text error messages are sent.
SendWriteValue	The supplied WriteValue is also to be sent again.
Transaction	Only valid for Config values: If a change in a command fails, the old status becomes active again.
ValidateRead	Also validates the values when reading against the schema.
UniqueHash	Setting this option prevents aggregation of multiple client subscriptions on the server side.
ProcessTimingAsTimespan	The request timings are sent as a timespan (since server start) instead of timestamps.
Extension1
Extension2
Extension3
Extension4