Service: Timer

Reading and editing the timers

Functions

Result	Name / Params			Comment
TimerGetResult	timer.Get			Returns a filtered list of Timer Objects.
		mode	string	(Optional) View of the objects to return: raw or effective. Default is effective. See DataMode.
		include	string	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). See DataMode.
		filter	DataFilter	(Optional) Filter definition which determines the result set.
		sort	DataSortItem[]	(Optional) Sorting definition as a list of properties with order.
		offset	int	(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
		limit	int	(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
		select	string[]	(Optional) List of properties that should be contained in the result objects.
TimerGetResult	timer.GetNext			Returns a filtered list of Timer Objects as a follow up to a previous Get call.
		context	string	The context received within the last get result. Mandatory for subsequent get calls with pagination.
		scroll	int	(Optional) Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See PaginationScroll.
		offset	int	(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
		limit	int	(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
Timer	timer.GetOne			Returns a single Timer Object identified by the given id.
		id	guid	The Timer's id.
		mode	string	(Optional) View of the object to return: raw or effective. Default is effective. See DataMode.
		include	string	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). See DataMode.
		select	string[]	(Optional) List of properties that should be contained in the result object.
guid	timer.Create			Creates the Timer in the system and returns the id of the Timer. The Timer must not have an id. If an id is set, the creation is rejected and an empty id is returned.
guid		object	TimerRaw	The Timer to create.
bool	timer.Update			Updates a Timer with data from the provided Object.
		id	guid	Id of the Timer to update.
		object	TimerRaw	Timer to update
bool	timer.Set			Sets specific properties of a Timer Object.
		id	guid	Id of the Timer to modify.
		props	value{}	(Key: SymbolPath) List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object.
bool	timer.Delete			Deletes a Timer Object. Returns true if successfully deleted or if no such Object existed to begin with.
bool		id	guid	Id of the Timer to delete.
bool	timer.BulkModify			Performs a bulk of changes at once.
		create	TimerRaw[]	(Optional) List of Timer Objects to create.
		update	TimerRaw[]	(Optional) List of Timer Objects to update.
		set	ObjectAspect[]	(Optional) List of Timer Object properties to set.
		delete	guid[]	(Optional) List of Timer ids to delete.

Notifications

Name / Params			Comment
timer.Created			Notifies about new Timer Objects.
	objects	Timer[]	Newly created Timer Objects.
timer.Updated			Notifies about updated Timer Objects.
	objects	Timer[]	Changed Timer Objects.
timer.Deleted			Notifies about deleted Timer Objects.
	ids	guid[]	Ids of the deleted Timer Objects.

Objects

Timer

This object extends TimerRaw.

Property	Type	Description
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

TimerGetResult

Property	Type	Description
Objects	Timer[]	Array of Objects.
Pagination	Pagination	Describes the result set, if not all Objects were returned.

TimerRaw

Property	Type	Description
Id	guid	(Readonly)
Name	string	Timer name.
Duration	int	Duration of the timer in total seconds.
Flags	int	Enable or disable explicit stop of timer by the user. See CanStopExplicitly.
HintSpan	int	Remaining time after which the hint status is activated.
HintSound	string	Sound file to play when time for the hint is reached (Path or FileId).
HintScript	string	Script to execute when time for the hint is reached (Path or FileId).
WarningSpan	int	Remaining time after which the warning status is activated.
WarningSound	string	Sound file to play when time for the warning is reached (Path or FileId).
WarningScript	string	Script to execute when time for the warning is reached (Path or FileId).
EndSound	string	Sound file to play when timer reached end time (Path or FileId).
EndScript	string	Script to execute when timer reached end time (Path or FileId).

Enums

CanStopExplicitly

Name	Value	Description
CanNotStop	0	Timer can not be explicitly stopped.
CanStop	1	Timer can be explicitly stopped.

Last modified September 25, 2026