getBoardInfo

Availability

This routine is available starting with SIL Engine™ 4.8.1.

Syntax

getBoardInfo(infoType, [user])

Description

Gets information about the board such as the id, name, or the board admins username.

Parameters

Parameter name

Type

Required

Description

Info TypeStringYesAcceptable values are ID, NAME, or ADMIN.
UserStringNoOptional username parameter to specify a user who can retrieve the board information. By default the current user (user who executed the script) is used and it is possible that the user may not have permissions to view the board.

Return type

String

Example 1

return getBoardInfo("ID

Result: The "ChildGroup will be added as child to the "ParentGroup".

Example 2

addGroupsToGroup({"Group1","Group2","Group3"}, {"Child1","Child2"});

Result: "Child1", "Child2" will be added as child groups for "Group1","Group2","Group3".

See also