import GroupController from 'itslanguage/administrative-sdk/group/group-controller.js'

private class | source

GroupController

Controller class for the Group model.

Constructor Summary

Public Constructor
public	constructor(connection: Connection)

Private Members
private	_connection: Connection Object to use for making a connection to the REST API and Websocket server.

Public Methods
public	createGroup(group: Organisation): Promise<Group> Create a group.
public	getGroup(groupId: string): Promise<Group> Get a group which is part of the current active Organisation derived from the OAuth2 scope.
public	getGroups(): Promise<Group[]> Get and return all groups in the current active Organisation derived from the OAuth2 scope.

Name	Type	Attribute	Description
connection	Connection		Object to use for making a connection to the REST API and Websocket server.

Object to use for making a connection to the REST API and Websocket server.

Create a group. The group will be part of the current active Organisation derived from the OAuth2 scope.

Name	Type	Attribute	Description
group	Organisation		Object to create.

Promise containing the newly created Group.

Promise.<Error>	organisation parameter of type "Group" is required.
Promise.<Error>	If the server returned an error.

Get a group which is part of the current active Organisation derived from the OAuth2 scope.

Name	Type	Attribute	Description
groupId	string		Specify a group identifier.

Promise containing an Group.

Promise.<Error>	groupId parameter of type "string" is required.
Promise.<Error>	If no result could not be found.

Get and return all groups in the current active Organisation derived from the OAuth2 scope.

Promise containing an array of Groups.

Promise.<Error>

If no result could not be found.