This article describes the API used to develop client plug-ins, as well as client-side form scripts.
...
Type | Description | Data |
|---|---|---|
LOGOUT | On logout. | |
CLIENT_LOCALE_CHANGED | The client locale was changed. | ISO locale string |
SCHEMA_LOCALE_CHANGED | The schema locale was changed. | ISO locale string |
DMS_OBJECT_DELETED | A DMS object was deleted. | the deleted DMS object |
DMS_OBJECT_VERSION_RESTORED | An older version of a DMS object was restored. | the ID of the restored DMS object |
DMS_OBJECT_FAVORITE_ON | A DMS object was added to the favorites. | the ID of the DMS object |
DMS_OBJECT_FAVORITE_OFF | A DMS object was removed from the favorites. | the ID of the DMS object |
DMS_OBJECT_UPDATED | A DMS object was updated (metadata, content, subscription, ...). | the updated DMS object |
DMS_OBJECT_PASTED | A DMS object was pasted into a new context folder. | the pasted DMS object |
EO_DIALOG_STACK_CHANGED | The dialog stack was changed. | an object with ID and active status of the dialog |
| PROCESS_FILE_CHANGED | Triggering this event caues causes the process file list to be updated with given file entries. | an array of file entries |
scope.api.events.trigger()
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
// how to create a subscription
var objectId = '7B683C8E19BD492198F6A262D14EF43F';
var body = {subject: 'My subscription', type: 'document'};
scope.api.http.post('/service/dms/subscription/' + objectId, body, '/rest-ws').then(
function(result){
scope.api.util.notifier.info('Created subscription for ' + objectId, 'Success');
},
function(error){
scope.api.util.notifier.error('Failed to create subscription for ' + objectId, 'Error');
}
);
// For more information, see the REST function descriptions. |
scope.api.dms
This section describes the read access to object information.
scope.api.dms.getObject()
Loads a DMS object from the backend.
| Parameter | Type | Description |
|---|---|---|
id | string | The ID of the DMS object to be fetched. |
type | string | optional: The object type of the selected DMS object. Will improve performance if set. |
version | string | optional: Retrieve a specific version of the DMS object. |
...
| Parameter | Type | Description |
|---|---|---|
dmsObject | DmsObject | the DMS object with the content to download |
rendition | string | (optional) the type of the content file ('PDF', 'TIFF', 'TEXT', 'JPEG') if you don't want to have the original file |
scope.api.config
Gets information about configurations.
scope.api.config.get()
This function returns information about the location of special resources.
| Config entry | Description |
|---|---|
| serviceBase | relative URL to the yuuvis® RAD rest services |
scope.api.agent
These functions help to handle custom actions with yuuvis® RAD agent.
scope.api.agent.getAvailability()
This function gets the agent availability and returns a promise which is resolved with the agent availability.
| Promise | Description |
|---|---|
agentAvailability.CONNECTED | The user has an agent connected and the current browser session is connected. |
agentAvailability.AVAILABLE | The user has an agent connected to the system, but there is no pairing between the current browser session and an agent. |
agentAvailability.UNAVAILABLE | The user is not connected with any agent. |
For examples, see the Client-side Custom Action Scripting documentation.
...