A

AAUIDParserClass in namespace CloudObjects\SDK\AccountGateway
AccountContextClass in namespace CloudObjects\SDK\AccountGateway
The context of an request for an account.
APIClientFactoryClass in namespace CloudObjects\SDK\WebAPI
The APIClientFactory can be used to create a preconfigured Guzzle HTTP API client based on the configuration data available for an API on CloudObjects.

C

COIDParserClass in namespace CloudObjects\SDK
The COIDParser can be used to validate COIDs and extract information.
CoreAPIExceptionClass in namespace CloudObjects\SDK\Exceptions
An Exception that is thrown when the Core API returned an error.
APIClientFactory::createClient() — Method in class APIClientFactory
Create a client.

D

DataLoaderClass in namespace CloudObjects\SDK\AccountGateway

F

AAUIDParser::fromString() — Method in class AAUIDParser
Creates a new IRI object representing a AAUID from a string.
AccountContext::fromSymfonyRequest() — Method in class AccountContext
Create a new context from the current request.
DataLoader::fetchAccountGraphDataDocument() — Method in class DataLoader
COIDParser::fromString() — Method in class COIDParser
Creates a new IRI object representing a COID from a string.
ObjectRetriever::fetchObjectsInNamespaceWithType() — Method in class ObjectRetriever
Fetch all object descriptions for objects in a specific namespace and with a certain type from CloudObjects. Adds individual objects to cache and returns a list of COIDs (as IRI) for them. The list itself is not cached, which means that every call of this function goes to the Object API.
ObjectRetriever::fetchAllObjectsInNamespace() — Method in class ObjectRetriever
Fetch all object descriptions for objects in a specific namespace from CloudObjects. Adds individual objects to cache and returns a list of COIDs (as IRI) for them. The list itself is not cached, which means that every call of this function goes to the Object API.

G

AAUIDParser::getType() — Method in class AAUIDParser
AAUIDParser::getAAUID() — Method in class AAUIDParser
AAUIDParser::getQualifier() — Method in class AAUIDParser
AccountContext::getAAUID() — Method in class AccountContext
AccountContext::getAccessToken() — Method in class AccountContext
AccountContext::getRequest() — Method in class AccountContext
AccountContext::getDataLoader() — Method in class AccountContext
AccountContext::getAccount() — Method in class AccountContext
AccountContext::getPerson() — Method in class AccountContext
AccountContext::getConnectionQualifier() — Method in class AccountContext
Get the qualifier of the account connection used for accessing the API.
AccountContext::getInstallQualifier() — Method in class AccountContext
Get the qualifier for the connection to the platform service.
AccountContext::getAccessorCOID() — Method in class AccountContext
Get the accessor.
AccountContext::getAccountDomain() — Method in class AccountContext
Get the account's domain.
AccountContext::getConnectedAccount() — Method in class AccountContext
Get a connected account.
AccountContext::getAccountConnection() — Method in class AccountContext
Get an account connection.
AccountContext::getConnectedAccountForService() — Method in class AccountContext
Get the connected account for a service.
AccountContext::getAllAccountConnections() — Method in class AccountContext
Get all account connections.
AccountContext::getAllConnectedAccounts() — Method in class AccountContext
Get all connected accounts.
AccountContext::getClient() — Method in class AccountContext
Get a preconfigured Guzzle client to access the Account Gateway.
AccountContext::getLatestAccessorVersionCOID() — Method in class AccountContext
Get the COID of the latest accessor version, if one is available, or null otherwise. This information is updated from incoming and outgoing requests. If no request was executed, returns null.
DataLoader::getCache() — Method in class DataLoader
DataLoader::getCachePrefix() — Method in class DataLoader
DataLoader::getMountPointName() — Method in class DataLoader
COIDParser::getType() — Method in class COIDParser
Get the type of a COID.
COIDParser::getName() — Method in class COIDParser
Get the name segment of a valid COID or null if not available.
COIDParser::getVersion() — Method in class COIDParser
Get the version segment of a valid, versioned COID or null if not available.
COIDParser::getVersionWildcard() — Method in class COIDParser
Get the version segment of a versioned or version wildcard COID or null if not available.
COIDParser::getNamespaceCOID() — Method in class COIDParser
Returns the COID itself if it is a root COID or a new IRI object representing the namespace underlying the given COID.
NodeReader::getFirstValueString() — Method in class NodeReader
Reads a property from a node and converts it into a string.
NodeReader::getFirstValueIRI() — Method in class NodeReader
Reads a property from a node and converts it into a IRI.
NodeReader::getFirstValueNode() — Method in class NodeReader
Reads a property from a node and returns it as a Node.
NodeReader::getAllValuesString() — Method in class NodeReader
Reads all values from a node and returns them as a string array.
NodeReader::getAllValuesIRI() — Method in class NodeReader
Reads all values from a node and returns them as a IRI array.
NodeReader::getAllValuesNode() — Method in class NodeReader
Reads all values from a node and returns them as a Node array.
ObjectRetriever::getClient() — Method in class ObjectRetriever
Get the HTTP client that is used to access the API.
ObjectRetriever::getObject() — Method in class ObjectRetriever
Get an object description from CloudObjects. Attempts to get object from in-memory cache first, stored static configurations next, configured external cache third, and finally calls the Object API on CloudObjects Core. Returns null if the object was not found.
ObjectRetriever::get() — Method in class ObjectRetriever
Get an object description from CloudObjects. Shorthand method for "getObject" which allows passing the COID as string instead of IRI.
ObjectRetriever::getAttachment() — Method in class ObjectRetriever
Get a object's attachment.

H

NodeReader::hasType() — Method in class NodeReader
Checks whether a node has a certain type.
NodeReader::hasPropertyValue() — Method in class NodeReader
Checks whether a node has a specific value for a property.
NodeReader::hasProperty() — Method in class NodeReader
Checks whether the node has at least one value for a property.

I

AccountContext::isNewAccessorVersionAvailable() — Method in class AccountContext
Check whether a new version of the accessor is available. This information is updated from incoming and outgoing requests. If no request was executed, returns false.
COIDParser::isValidCOID() — Method in class COIDParser
Checks whether the given IRI object is a valid COID.

N

NodeReaderClass in namespace CloudObjects\SDK
The NodeReader provides some convenience methods for reading information from an object graph node.

O

ObjectRetrieverClass in namespace CloudObjects\SDK
The ObjectRetriever provides access to objects on CloudObjects.

P

AccountContext::pushGraphUpdates() — Method in class AccountContext
Pushes changes on the Account Graph into the Account Graph.
AccountContext::processResponse() — Method in class AccountContext
Process a response and add headers if applicable.

S

AccountContext::setAccountGatewayBaseURLTemplate() — Method in class AccountContext
Specifies a template for the Account Gateway Base URL. Must be a valid URL that may contain an {aauid} placeholder. Call this if you want to redirect traffic through a proxy or a staging or mock instance of an Account Gateway. Most users of this SDK should never call this function.
AccountContext::setLogCode() — Method in class AccountContext
Set a custom code for the current request in the Account Gateway logs.
AccountContext::setLatestAccessorVersionCOID() — Method in class AccountContext
Set the COID of the latest accessor version. This method should only called from request processing codes. Most developers should not use it.
DataLoader::setCache() — Method in class DataLoader
DataLoader::setCachePrefix() — Method in class DataLoader
DataLoader::setMountPointName() — Method in class DataLoader
SharedSecretAuthenticationClass in namespace CloudObjects\SDK\Helpers
The SharedSecretAuthentication helper allows developers to quickly implement authentication based on CloudObjects shared secrets.
ObjectRetriever::setClient() — Method in class ObjectRetriever
Set the HTTP client that is used to access the API.

U

AccountContext::usesAccountConnection() — Method in class AccountContext
Checks whether the context uses an account connection, which is the case when an API is requested by a connected account on another service.

V

SharedSecretAuthentication::verifyCredentials() — Method in class SharedSecretAuthentication
Verifies credentials.

_

AccountContext::__construct() — Method in class AccountContext
Create a new context using an AAUID and an OAuth 2.0 bearer access token.
NodeReader::__construct() — Method in class NodeReader
ObjectRetriever::__construct() — Method in class ObjectRetriever