User functions

Function

Description

List<user> listUsers()

Returns list of all users

List<user>  listUsers(filter)

Returns list of all users, that are filtered by user

List<user> listUsersByRole(role)

Returns list of all users, that are filtered by role

List<user> listUsersInGroup(groupName)Return list of all users, that are filtered by groupName
int findGroupByName(groupName)Returns ID of group by groupName
string getUserEmailById(int user_id)Returns user's email when ID is provided

Properties of object user from listUsers

Function

Description

String user.dateFormat

Get user's date format

String user.email

Get user's email

String user.name

Get user's first name

String user.middlename

Get user's middlename

String user.infoGet user's information
String user.surnameGet user's surname
String user.locale
Get user's language
String user.timeFormat
Get user's time format
String user.timeZone
Get user's time zone
String user.username
Get user's username
String user.phone
Get user's phone
String user.phone2
Get user's mobile
String user.roles
Get user's roles
String user.role
Get user's parameters
String user.groups
Get user's group
String user.id
Get user's id
String user.name
Get user's group name
String user.disableComments
Get info if user has disabled comments

Folder functions

Function

Description

int createFolder()

Returns id of created folder. UUID will be used to generate name

int createFolder(string name)Returns id of created folder. Name of folder is specified as parameter

Folder methods

Function

Description

shareFolderWithGroup(int folderId, int groupId)

Shares folder (using folderId) with group (using groupId)

Dataset functions

Function

Description

List<String> allValues(string attCode)Returns list of values from current dataset for specific attribute (using attCode)

List<String> allValues(string dataSetCode, string attCode)

Returns list of values from selected dataset (using dataSetCode) for specific attribute (using attCode)

List<String> allValuesTranslated(string attCode)Returns list of values that are converted using appearance formula from current dataset for specific attribute (using attCode)

List<String> allValuesTranslated(string dataSetCode, string attCode)

Returns list of values that are converted using appearance formula from selected dataset (using dataSetCode) for specific attribute (using attCode)

String stringValue()Returns string for indicator. It is used instead of value() that returns int on indicator place.

Media Gallery functions

Function

Description

String getMediaFile(int ID).filename

Returns filename of media gallery file according to it's ID

String getMediaFile(int ID).titleReturns title of media gallery file according to it's ID
String getMediaFile(int ID).uploaderUsernameReturns username of file createor according to it's ID
LocalDateTime getMediaFile(int ID).createdWhenReturns DateTime when file according to it's ID was created.
List<ImgData> getMediaFile(int ID).data

Returns additional information about pictures

Properties of object ImgData

Function

Description

Long ImgData.blobId

Returns blob ID

String ImgData.contentType

Returns content type of an object.

  • No labels