import {Group} from '@fnndsc/chrisapi'

public class | source

Group

Group item resource object representing a group.

Constructor Summary

Public Constructor
public	constructor(url: string, auth: Object) Constructor

Public Methods
public	adminAddUser(username: string, timeout: number): Promise<GroupUser> Add a user to the group given the user's username.
public	delete(timeout: number): Promise Make a DELETE request to delete this group item resource through the REST API.
public	getUser(username: string, timeout: number): Promise<GroupUser\|null> Get a group user given the username.
public	getUsers(searchParams: Object, timeout: number): Promise<GroupUserList> Fetch the list of group's users from the REST API.

From class Resource
public static	cloneObj(obj: Object): * Helper method to make a deep copy clone of the passed object resource.
public get	isEmpty: boolean Return true if the resource object contains any data.
public	auth: Object
public	collection: Object
public	contentType: string
public	url: string
public	clone(): Resource Make a deep copy clone of this object resource.

From class ItemResource
public get	data: Object Get the item's data object (REST API descriptors).
public	collection: *
public	get(timeout: number): Promise<this> Fetch this item resource from the REST API.
public	getPUTParameters(): string[] Get an array of parameter names that can be used as properties of the data object in PUT requests.
private	_delete(timeout: number): Promise Internal helper method to make a DELETE request to this item resource through the REST API.
private	_getResource(linkRelation: string, ResourceClass: Object, searchParams: Object, timeout: number): Promise<ResourceClass> Internal method to fetch a related resource from the REST API that is referenced by a link relation within the item object.
private	_put(data: Object, uploadFileObj: Object, timeout: number): Promise<this> Internal helper method to make a PUT request to this item resource through the REST API.

Constructor

Add a user to the group given the user's username.

JS Promise, resolves to a GroupUser object

Make a DELETE request to delete this group item resource through the REST API.

Name	Type	Attribute	Description
timeout	number	optional default: 30000	request timeout

JS Promise

Get a group user given the username.

JS Promise, resolves to a GroupUser object or null

Fetch the list of group's users from the REST API.

Name	Type	Attribute	Description
searchParams	Object	optional default: null	search parameters object
searchParams.limit	number	optional	page limit
searchParams.offset	number	optional	page offset
searchParams.id	number	optional	match group-user id exactly with this number
searchParams.username	string	optional	match the username exactly with this string
timeout	number	optional default: 30000	request timeout

JS Promise, resolves to a GroupUserList object