Class Index | File Index

Classes


Namespace LABKEY.ParticipantGroup

Participant group static class to update participant group information.

Additional Documentation:


Defined in: ParticipantGroup.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
LABKEY.ParticipantGroup.updateParticipantGroup(config)
Updates an existing participant group, already saved and accessible to the current user on the server.
Namespace Detail
LABKEY.ParticipantGroup
Method Detail
<static> LABKEY.ParticipantGroup.updateParticipantGroup(config)
Updates an existing participant group, already saved and accessible to the current user on the server.
Parameters:
{Object} config
An object which contains the following configuration properties. The group properties are not included in the config, their values will remain unchanged.
{Function} config.success
Required. Function called when the request executes successfully. Will be called with the arguments:
  • group: the new state of the participant group, with properties rowId, participantIds, label and description.
  • response: the full response object from the AJAX request.
{Function} config.failure Optional
Function called when execution of the request fails.
{int} config.rowId
The integer ID of the desired participant group
{Array} config.participantId Optional
Set of IDs to be members of the group
{Array} config.ensureParticipantIds Optional
Set of IDs to be added to the group if they are not already members
{Array} config.deleteParticipantIds Optional
Set of IDs to be removed from the group if they are already members
{Array} config.label Optional
The new value for the label of the group
{Array} config.description Optional
The new value for the description of the group
{String} config.containerPath Optional
The container path in which the relevant study is defined. If not supplied, the current container path will be used.

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Mar 14 2019 22:39:26 GMT-0000 (UTC)