openassetio::v1::hostApi Namespace Reference

This namespace contains code relevant to anyone wanting to add support for a host application. More...

Classes
class	EntityReferencePager
	The EntityReferencePager allows for the retrieval and traversal of large datasets in a paginated manner. More...
class	HostInterface
	The HostInterface provides an abstraction of the 'caller of the API'. More...
class	Manager
	The Manager is the Host facing representation of an Asset Management System. More...
class	ManagerFactory
	The ManagerFactory is the primary mechanism for querying for available managers and constructing a Manager. More...
class	ManagerImplementationFactoryInterface
	Manager Factories are responsible for instantiating classes that derive from openassetio::v1::managerApi::ManagerInterface for use within a host. More...

Typedefs
using	EntityReferencePagerPtr = std::shared_ptr< EntityReferencePager >
using	EntityReferencePagerConstPtr = std::shared_ptr< const EntityReferencePager >
using	HostInterfacePtr = std::shared_ptr< HostInterface >
using	HostInterfaceConstPtr = std::shared_ptr< const HostInterface >
using	ManagerPtr = std::shared_ptr< Manager >
using	ManagerConstPtr = std::shared_ptr< const Manager >
using	ManagerImplementationFactoryInterfacePtr = std::shared_ptr< ManagerImplementationFactoryInterface >
using	ManagerImplementationFactoryInterfaceConstPtr = std::shared_ptr< const ManagerImplementationFactoryInterface >
using	ManagerFactoryPtr = std::shared_ptr< ManagerFactory >
using	ManagerFactoryConstPtr = std::shared_ptr< const ManagerFactory >

Functions
OPENASSETIO_CORE_EXPORT std::ostream &	operator<< (std::ostream &out, const Manager::Capability &formattable)
	Insertion operator for use with ostreams. More...

Detailed Description

This namespace contains code relevant to anyone wanting to add support for a host application.

If you are a asset management system developer, see managerApi.

Typedef Documentation

using EntityReferencePagerConstPtr = std::shared_ptr<const EntityReferencePager >

using EntityReferencePagerPtr = std::shared_ptr< EntityReferencePager >

typedef std::shared_ptr< const HostInterface > HostInterfaceConstPtr

typedef std::shared_ptr< HostInterface > HostInterfacePtr

typedef std::shared_ptr< const Manager > ManagerConstPtr

using ManagerFactoryConstPtr = std::shared_ptr<const ManagerFactory >

using ManagerFactoryPtr = std::shared_ptr< ManagerFactory >

typedef std::shared_ptr< const ManagerImplementationFactoryInterface > ManagerImplementationFactoryInterfaceConstPtr

typedef std::shared_ptr< ManagerImplementationFactoryInterface > ManagerImplementationFactoryInterfacePtr

typedef std::shared_ptr< Manager > ManagerPtr

Function Documentation

OPENASSETIO_CORE_EXPORT std::ostream& openassetio::v1::hostApi::operator<<	(	std::ostream &	out,
		const Manager::Capability &	formattable
	)

Insertion operator for use with ostreams.

Formats as "humanReadableCapabilityName".