...
These are the available type classes for generic methods.
| Name | Description |
|---|
...
Dictionary | A dictionary |
...
| for the current client |
...
| Domain | A domain in the currently selected dictionary |
...
| Language | A |
...
language in the currently selected dictionary | |
| Section | A section in the currently selected dictionary |
...
...
| ConceptEntry | A concept entry in the currently selected dictionary |
| TermEntry | A term entry in the currently selected dictionary |
| Filter | A filter for the current client |
| ImportSettings | An import settings for the current client |
| VirtualFile | A virtual file (and also import file) for the current client |
| Project | A project for the current client |
| Client | A client in the system |
| User | A user for the current client |
Generic methods
The table below describes the available generic methods. The type argument is the name of the type, and is a case-insensitive string.
The type name can also be appended by additional request parameters to modify the returned object.
| Method | Applicable Types | Description | Returns | Return type |
|---|---|---|---|---|
getAll(sessionID, type) | Client | Returns all objects of the specified type that are available for the user. | List of objects | array |
getSelected(sessionID, type) | Client | Returns the currently selected object of the specified type. | Object (see Data objects) | struct |
getObject(sessionID, type, objID) | Client | Returns the object with specified ID and type. | Object (see Data objects) | struct |
getObjectByName(sessionID, type, name) | Client | Returns the object with specified ID and name. | Object (see Data objects) | struct |
getSelectedList(sessionID, type) | Domain | Returns a list of the currently selected object(s) of the specified type. | List of objects | array |
setSelected(sessionID, type, objID) | Client | Sets the object with specified ID and type to be selected. | 0 | int |
setSelected(sessionID, type, idList) | Domain | Sets the objects with specified IDs and type to be selected. | 0 | int |
setAllSelected(sessionID, type) | Domain | Sets all objects of the specified type to be selected. | 0 | int |
isSelected(sessionID, type, objID) | Client | Checks if the object with specified ID and type is selected. | True if selected | boolean |
exists(sessionID, type, objID) | Client | Checks if the object with specified ID and type exists. | True if exists | boolean |
existsByName(sessionID, type, name) | Client | Checks if the object with specified ID and type exists. | True if exists | boolean |