Service: Module

Reading the available modules

Functions

Result	Name / Params			Comment
ModuleGetResult	module.Get			Returns a filtered list of Module Objects.
		mode	DataMode	(Optional) View of the objects to return: raw or effective. Default is effective.
		include	DataMode	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay).
		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.
ModuleGetResult	module.GetNext			Returns a filtered list of Module 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	PaginationScroll	(Optional) Scrolls through the result set with 'Next' or 'Prev'. Used for pagination.
		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)
Module	module.GetOne			Returns a single Module Object identified by the given code.
		code	string	The Module's code
		mode	DataMode	(Optional) View of the object to return: raw or effective. Default is effective.
		include	DataMode	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay).
		select	string[]	(Optional) List of properties that should be contained in the result object.

Notifications

Name / Params			Comment
module.Created			Notifies new Module Objects.
	objects	Module[]	Newly created Module objects.
module.Updated			Notifies updated Module Objects.
	objects	Module[]	Changed Module Objects.
module.Deleted			Notifies deleted Module Objects.
	ids	string[]	Codes of the deleted Module Objects.

Objects

Module

Property	Type	Description
Code	string	(Unique) Code of the Module, used in URLs.
Name	string	Name of the Module.
Version	string	Version of the Module.
Type	string	Type info of the Module See ModuleType.
Author	string	Name of the Module’s author.
Traits	string[]	Supported Traits. See ModuleTrait.
Configurations	string[]	Available configurations.
Props	value{}	Additional properties.

ModuleGetResult

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

Enums

ModuleTrait

Name	Value	Description
Adapter	adapter	Interface to external objects with States, and Events.
Monitor	monitor	Provides data streams to visualize monitor information.
AP	ap	Supports querying Objects for Automatic Data Supply.
UI	ui	Provides ui content.
X4	X4	This is a legacy X4 module.
Browsable	browsable	Supports querying Objects for specific Nodes.
Settings	settings	Has individual Settings.
Demo	demo	Can run without license.
NoLic	nolic	Can run without license.
MultiStation	multistation	Can be operated at several stations.
Concurrent	concurrent	Allows creating Events on stations running in local mode. Use responsibly. Only recommended for notification Events.
MultiClient	multiclient	Multiple clients of this module can connect simultaneously.
ControlPanel	controlpanel	Can display an Extension provided Control Panel.
UserAuthentication	userauth	Uses user sessions obtained from OAuth to authenticate against the AOP Node.
Help	help	Help files are available for display.
Manageable	manageable	The module can be managed by the App, e.g. started and stopped.
LocalObjects	localobjects	Only exchange local Objects (e.g. local telephones) between the AOP server and the extension, i.e. the extension knows different objects depending on the station it runs on and thus can only trigger app states and app events for these objects. The extension may still receive operations for “non-local” objects.

ModuleType

Name	Value	Description
System	sys	Internally managed module
Module	mod	Default module type

Last modified September 25, 2026