openassetio::v1::constants Namespace Reference

Constants used throughout the OpenAssetIO API. More...

Variables
Info dictionary field names.
Bare strings should never be used to help protect against inconsistencies and future changes.
constexpr std::string_view	kInfoKey_SmallIcon = "smallIcon"
constexpr std::string_view	kInfoKey_Icon = "icon"
constexpr std::string_view	kInfoKey_EntityReferencesMatchPrefix
	Common prefix for all entity references of a particular manager. More...

Detailed Description

Constants used throughout the OpenAssetIO API.

Variable Documentation

constexpr std::string_view kInfoKey_EntityReferencesMatchPrefix

inline

Initial value:

=
    "entityReferencesMatchPrefix"

Common prefix for all entity references of a particular manager.

This field may be used by the API to optimize queries to isEntityReferenceString in situations where bridging languages, etc. can be expensive (particularly in the case of python plug-ins called from multi-threaded C++).

constexpr std::string_view kInfoKey_Icon = "icon"

inline

constexpr std::string_view kInfoKey_SmallIcon = "smallIcon"

inline