Skip to main content
Version: 2.10

API

Classes

ClassDescription
CloudObjectA CloudObject is the base class for all objects that can be persisted and exchanged between Olympe applications. In essence, it represents a remote reference to an object in the data cloud. It is identified by its unique ID, or tag. From a CloudObject you can access related CloudObjects.
EnumAn Enum is an ordered list of string key-values mappings
EnumValueAn EnumValue is a single value part of an Enum. It has a string name, a rank (its position in the Enum list).
FileFile is the main class used to create business objects with a binary/string data content. It is a Data Type so can be extended and associated to a data source.

Type Aliases

Type AliasDescription
InstanceOrTagA InstanceOrTag can be either a string, a HasTag (CloudObject instance, Property, Relation, ...) or the class constructor for a CloudObject

Functions

FunctionDescription
defineInverseRelationReturns a constant object corresponding to the specified relation going to the opposite direction
definePropertyCreate a constant property object which has the specified tag and type to be used in coded bricks.
defineRelationCreate a constant relation object between two specified DataTypes.
registerRegister the class constructor as the class associated to the specified tag.