Class ChRISGroupGroup

Group handler for ChRIS user groups.

Hierarchy (View Summary)

ChRISResourceGroup
- ChRISGroupGroup

Index

Constructors

Properties

Accessors

Methods

client_get groups_getAll members_getAll user_add user_remove

Constructors

constructor

new ChRISGroupGroup(): ChRISGroupGroup
Returns ChRISGroupGroup
Overrides ChRISResourceGroup.constructor
- Defined in packages/cumin/src/groups/chrisGroups.ts:73

Properties

`Protected`_asset

_asset: ChRISResource

Accessors

asset

get asset(): ChRISResource
Returns ChRISResource
Inherited from ChRISResourceGroup.asset
- Defined in packages/cumin/src/resources/chrisResourceGroup.ts:52

Methods

client_get

client_get(): Promise<Client | null>
Retrieves the ChRIS client instance asynchronously.

Returns Promise<Client | null>
A Promise resolving to the Client instance or null.
Inherited from ChRISResourceGroup.client_get
- Defined in packages/cumin/src/resources/chrisResourceGroup.ts:48

groups_getAll

groups_getAll(): Promise<Result<ChrisGroup[]>>
Fetches all groups, following the API's pagination links.

Returns Promise<Result<ChrisGroup[]>>
Every visible CUBE group, or Err on failure.
- Defined in packages/cumin/src/groups/chrisGroups.ts:104

members_getAll

members_getAll(groupID: number): Promise<Result<ChrisGroupMember[]>>
Fetches every user belonging to one group.
Parameters
- groupID: number
  Numeric CUBE group identifier.
Returns Promise<Result<ChrisGroupMember[]>>
Every group membership, or Err on failure.
- Defined in packages/cumin/src/groups/chrisGroups.ts:138

user_add

user_add(groupID: number, username: string): Promise<Result<ChrisGroupMember>>
Adds an existing CUBE user to one group.
Parameters
- groupID: number
  Numeric CUBE group identifier.
- username: string
  Existing CUBE username to add.
Returns Promise<Result<ChrisGroupMember>>
The created membership, or Err when CUBE refuses the operation.
- Defined in packages/cumin/src/groups/chrisGroups.ts:180

user_remove

user_remove(groupID: number, username: string): Promise<Result<boolean>>
Removes a CUBE user from one group.
Parameters
- groupID: number
  Numeric CUBE group identifier.
- username: string
  Existing CUBE username to remove.
Returns Promise<Result<boolean>>
True after deletion, or Err when the membership does not exist or deletion fails.
- Defined in packages/cumin/src/groups/chrisGroups.ts:206