Skip to main content
Version: Next

Olympe Code API

The Code API allows writing Coded Actions, Coded Functions and Coded Visual Components. Bricks can embed any library or code, and the Olympe API provides classes and methods allowing integration with Olympe specific elements.

Runtime​

The Runtime section includes the classes and methods required to:

  • Declare new bricks (Brick, VisualBrick)
  • Interact with Olympe execution context (BrickContext)
  • Handle errors (ErrorFlow)
  • Read environment-specific configuration values (Config)

Queries​

Data managed by Olympe is queries using Queries:

  • Declaring and building queries (Query, QuerySingle)
  • Managing predicates and ordering (Order, Predicate)
  • Handling results returned by those queries (QueryResult)

Transactions​

Modifiying data managed by Olympe requires executing Transactions:

  • Creating, executing or cancelling transactions (Transaction)
  • Handle results of those transactions (TransactionResult)

Data​

  • Generic data management capabilities (CloudObject)
  • Olympe-specific data types (Enum, File)

Advanced​

The elements above should cover 95% of use cases. Many more capabilities are available for more advanced use cases. The Olympe Core library available on GitHub is a good source of examples for such cases.

  • Data type reflection (determining object type, list of properties, etc, dynamically invoke methods or access properties, creating instances, ...)
  • Services and backend processes management
  • Authentication status
  • Global state variables
  • ...