Function: boardRole

Overview

boardRole controls whether a specific Limnu user can access a board and whether they are an admin of the board. An admin of the board can turn on and off leading and can edit the board when the board is in solo draw.

Parameters

Input parameters:

• apiKey: string - the API key issued by Limnu to developers
• boardId: string - the id of the board to modify
• userId: string - the id of the user to modify
• mayAdmin: boolean - (optional) If true, the specified user is an admin of the specified board. If false, admin status is removed. If not specified, no change to the admin status is made (and the default for a new user is false).
• enabled: boolean - (optional) If true, the specified user can access the board. If false, the specified user cannot access the board. By default, boards are public. If a user accesses a public board before a boardRole is set, the user is given permission to access it. The public flag on a board can be set by calling boardInfo, as described below.

If the function is called with no parameters, no changes are made (and the current values are returned).

Response Attributes:

The current values of mayAdmin and enabled are returned in the response.

mayAdmin: boolean- the current value of mayAdmin for the specified user and board - true if the user is an admin, false if the user is not an admin, and undefined if mayAdmin has never been set. The mayAdmin property may be undefined if the user has never accessed the board and mayAdmin has never been set through boardRole, boardCreate or boardInfo.

enabled: boolean - the current value of enabled for the specified user and board - true if the user is enabled, false if the user is not enabled and undefined if enabled has never been set. The enabled property may be undefined if the user has never accessed the board and enabled or mayAdmin has never been set through boardRole, boardCreate or boardInfo.