ApplicationApi
extends AbstractApi
in package
Use API to manage custom application data.
Table of Contents
Methods
- addApplicationData() : ApplicationData|null
- Add Application Data
- addConsent() : ApplicationConsent|null
- Add Application Consent
- addKvRecord() : ApplicationKvRecord|null
- Add Application KV Record
- applyInstallationUpdate() : ApplicationInstallation|null
- Apply Application Installation Update
- deleteApplicationData() : mixed
- Delete Application Data
- deleteConsent() : mixed
- Delete Application Consent
- deleteInstallation() : mixed
- Delete Application Installation
- deleteKvRecord() : mixed
- Delete Application KV Record
- editApplicationData() : ApplicationData|null
- Edit Application Data
- getApplicationData() : ApplicationData|null
- Get Application Data
- getInstallation() : ApplicationInstallation|null
- Get Application Installation
- getInstallationUpdate() : ApplicationInstallationUpdate|null
- Get Application Installation Update
- getKvRecord() : ApplicationKvRecord|null
- Get Application KV Record
- installApplication() : ApplicationInstallation|null
- Install Application
- listConsents() : ModelCollection
- List Application Consents
- listInstallations() : ModelCollection
- List Application Installations
- listKvRecords() : ModelCollection
- List Application KV Records
- updateConsent() : ApplicationConsent|null
- Edit Application Consent
- updateInstallation() : ApplicationInstallation|null
- Edit Application Installation
- updateKvRecord() : ApplicationKvRecord|null
- Edit Application KV Record
- updateOrRestoreApplicationData() : ApplicationData|null
- Update or Restore Application Data
- uploadInstallationBundle() : ApplicationInstallation|null
- Upload Application Installation Bundle
Methods
addApplicationData()
Add Application Data
public
addApplicationData(string $applicationIdentifier, string $path, array<string|int, mixed> $data) : ApplicationData|null
Parameters
- $applicationIdentifier : string
- $path : string
- $data : array<string|int, mixed>
Tags
Return values
ApplicationData|nulladdConsent()
Add Application Consent
public
addConsent(array<string|int, mixed> $data) : ApplicationConsent|null
Parameters
- $data : array<string|int, mixed>
-
string $data[identifier] required
integer $data[installedBy] required
string $data[status] required
array $data[scopes]
Tags
Return values
ApplicationConsent|nulladdKvRecord()
Add Application KV Record
public
addKvRecord(string $applicationIdentifier, array<string|int, mixed> $data) : ApplicationKvRecord|null
Parameters
- $applicationIdentifier : string
- $data : array<string|int, mixed>
-
string $data[key] required
mixed $data[value] required. Any JSON value except null
boolean $data[secret]
integer $data[ttl] Time to live in seconds (60-31536000)
Tags
Return values
ApplicationKvRecord|nullapplyInstallationUpdate()
Apply Application Installation Update
public
applyInstallationUpdate(string $identifier, array<string|int, mixed> $data) : ApplicationInstallation|null
Parameters
- $identifier : string
- $data : array<string|int, mixed>
-
string $data[manifestHash] required. From getInstallationUpdate()
Tags
Return values
ApplicationInstallation|nulldeleteApplicationData()
Delete Application Data
public
deleteApplicationData(string $applicationIdentifier, string $path) : mixed
Parameters
- $applicationIdentifier : string
- $path : string
Tags
deleteConsent()
Delete Application Consent
public
deleteConsent(int $consentId) : mixed
Parameters
- $consentId : int
Tags
deleteInstallation()
Delete Application Installation
public
deleteInstallation(string $identifier[, bool $force = false ]) : mixed
Parameters
- $identifier : string
- $force : bool = false
Tags
deleteKvRecord()
Delete Application KV Record
public
deleteKvRecord(string $applicationIdentifier, string $key) : mixed
Parameters
- $applicationIdentifier : string
- $key : string
Tags
editApplicationData()
Edit Application Data
public
editApplicationData(string $applicationIdentifier, string $path, array<string|int, mixed> $data) : ApplicationData|null
Parameters
- $applicationIdentifier : string
- $path : string
- $data : array<string|int, mixed>
-
Application-specific key-value payload (free-form, not RFC 6902 patch operations)
Tags
Return values
ApplicationData|nullgetApplicationData()
Get Application Data
public
getApplicationData(string $applicationIdentifier, string $path[, array<string|int, mixed> $params = [] ]) : ApplicationData|null
Parameters
- $applicationIdentifier : string
- $path : string
- $params : array<string|int, mixed> = []
Tags
Return values
ApplicationData|nullgetInstallation()
Get Application Installation
public
getInstallation(string $identifier) : ApplicationInstallation|null
Parameters
- $identifier : string
Tags
Return values
ApplicationInstallation|nullgetInstallationUpdate()
Get Application Installation Update
public
getInstallationUpdate(string $identifier) : ApplicationInstallationUpdate|null
Parameters
- $identifier : string
Tags
Return values
ApplicationInstallationUpdate|nullgetKvRecord()
Get Application KV Record
public
getKvRecord(string $applicationIdentifier, string $key) : ApplicationKvRecord|null
Parameters
- $applicationIdentifier : string
- $key : string
Tags
Return values
ApplicationKvRecord|nullinstallApplication()
Install Application
public
installApplication(array<string|int, mixed> $data) : ApplicationInstallation|null
Parameters
- $data : array<string|int, mixed>
-
string $data[url] required
array $data[permissions]
array $data[modules]
bool $data[assignAgent]
Tags
Return values
ApplicationInstallation|nulllistConsents()
List Application Consents
public
listConsents([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
string $params[identifier]
string $params[orderBy]
Tags
Return values
ModelCollectionlistInstallations()
List Application Installations
public
listInstallations([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
integer $params[installedBy]
string $params[orderBy]
Tags
Return values
ModelCollectionlistKvRecords()
List Application KV Records
public
listKvRecords(string $applicationIdentifier[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $applicationIdentifier : string
- $params : array<string|int, mixed> = []
-
string $params[prefix]
string $params[orderBy]
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionupdateConsent()
Edit Application Consent
public
updateConsent(ApplicationConsent $consent) : ApplicationConsent|null
Parameters
- $consent : ApplicationConsent
Tags
Return values
ApplicationConsent|nullupdateInstallation()
Edit Application Installation
public
updateInstallation(ApplicationInstallation $installation) : ApplicationInstallation|null
Parameters
- $installation : ApplicationInstallation
Tags
Return values
ApplicationInstallation|nullupdateKvRecord()
Edit Application KV Record
public
updateKvRecord(string $applicationIdentifier, string $key, array<string|int, mixed> $data) : ApplicationKvRecord|null
Parameters
- $applicationIdentifier : string
- $key : string
- $data : array<string|int, mixed>
-
JSON Patch array. Paths: /value, /ttl (null value removes the TTL)
Tags
Return values
ApplicationKvRecord|nullupdateOrRestoreApplicationData()
Update or Restore Application Data
public
updateOrRestoreApplicationData(string $applicationIdentifier, string $path, array<string|int, mixed> $data) : ApplicationData|null
Parameters
- $applicationIdentifier : string
- $path : string
- $data : array<string|int, mixed>
Tags
Return values
ApplicationData|nulluploadInstallationBundle()
Upload Application Installation Bundle
public
uploadInstallationBundle(string $identifier, array<string|int, mixed> $data) : ApplicationInstallation|null
Parameters
- $identifier : string
- $data : array<string|int, mixed>
-
integer $data[storageId] required. ZIP archive with a non-empty app.js at its root