GroupsDataSource

Defined in: js-api/src/dapi.ts:548

Functionality for handling groups collection from server Allows to manage Group

Extends

• HttpDataSource<Group>

Constructors

Constructor

new GroupsDataSource(s, clsName): GroupsDataSource

Defined in: js-api/src/dapi.ts:550

Parameters

Parameter	Type
s	any
clsName	string

Returns

GroupsDataSource

Constructs

CredentialsDataSource

Overrides

HttpDataSource.constructor

Properties

Property	Type	Inherited from	Defined in
clsName	string	HttpDataSource.clsName	js-api/src/dapi.ts:307
dart	any	HttpDataSource.dart	js-api/src/dapi.ts:306

Methods

addAdminMember()

addAdminMember(g, m): Promise<void>

Defined in: js-api/src/dapi.ts:577

Adds an admin member to the group

Parameters

Parameter	Type
g	Group
m	Group

Returns

Promise<void>

---

addMember()

addMember(g, m): Promise<void>

Defined in: js-api/src/dapi.ts:570

Adds a member to the group

Parameters

Parameter	Type
g	Group
m	Group

Returns

Promise<void>

---

allPackageVersions()

allPackageVersions(): HttpDataSource<Group>

Defined in: js-api/src/dapi.ts:362

Turns off package versions isolation. This DataSource will return all entities in all versions, not only the current one *

Returns

HttpDataSource<Group>

Inherited from

HttpDataSource.allPackageVersions

---

by()

by(i): HttpDataSource<Group>

Defined in: js-api/src/dapi.ts:367

Parameters

Parameter	Type
i	number

Returns

HttpDataSource<Group>

Inherited from

HttpDataSource.by

---

count()

count(): Promise<number>

Defined in: js-api/src/dapi.ts:333

Counts entities that satisfy the filtering criteria (see filter). See examples: https://public.datagrok.ai/js/samples/dapi/projects-list Smart filter: https://datagrok.ai/help/datagrok/smart-search

Returns

Promise<number>

Inherited from

HttpDataSource.count

---

createNew()

createNew(name): Promise<Group>

Defined in: js-api/src/dapi.ts:558

Creates a new group

Parameters

Parameter	Type
name	string

Returns

Promise<Group>

• Group.

---

currentUserGroups()

currentUserGroups(): Promise<Group[]>

Defined in: js-api/src/dapi.ts:624

Returns all groups the current user belongs to, including transitive parent groups.

Returns

Promise<Group[]>

---

delete()

delete(e): Promise<void>

Defined in: js-api/src/dapi.ts:357

Deletes an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise<void>

Inherited from

HttpDataSource.delete

---

excludeFrom()

excludeFrom(g, parent): Promise<void>

Defined in: js-api/src/dapi.ts:606

Removes a membership from the group

Parameters

Parameter	Type
g	Group
parent	Group

Returns

Promise<void>

---

filter()

filter(w): HttpDataSource<Group>

Defined in: js-api/src/dapi.ts:390

Applies filter to current request. Also can be set with list method "options" parameter See example: https://public.datagrok.ai/js/samples/dapi/projects-list Smart filter: https://datagrok.ai/help/datagrok/navigation/views/browse#entity-search

Parameters

Parameter	Type
w	string

Returns

HttpDataSource<Group>

Inherited from

HttpDataSource.filter

---

find()

find(id): Promise<Group>

Defined in: js-api/src/dapi.ts:347

Returns an entity with the specified id. Throws an exception if an entity does not exist, or is not accessible in the current context. Sample: https://public.datagrok.ai/js/samples/data-access/save-and-load-df

Parameters

Parameter	Type	Description
id	string	GUID of the corresponding object

Returns

Promise<Group>

{Promise<object>} - entity.

Inherited from

HttpDataSource.find

---

first()

first(): Promise<Group>

Defined in: js-api/src/dapi.ts:338

Returns fist entity that satisfies the filtering criteria (see filter).

Returns

Promise<Group>

Inherited from

HttpDataSource.first

---

getGroupsLookup()

getGroupsLookup(name): Promise<Group[]>

Defined in: js-api/src/dapi.ts:619

Looking for groups with similar name

Parameters

Parameter	Type
name	string

Returns

Promise<Group[]>

---

getUser()

getUser(group): Promise<Group>

Defined in: js-api/src/dapi.ts:565

Returns group user

Parameters

Parameter	Type
group	Group

Returns

Promise<Group>

• Group.

---

include()

include(include): HttpDataSource<Group>

Defined in: js-api/src/dapi.ts:402

Includes entity in the result

Parameters

Parameter	Type
include	string

Returns

HttpDataSource<Group>

Inherited from

HttpDataSource.include

---

includeAdminTo()

includeAdminTo(g, parent): Promise<void>

Defined in: js-api/src/dapi.ts:599

Adds the group to another one as admin

Parameters

Parameter	Type
g	Group
parent	Group

Returns

Promise<void>

---

includeTo()

includeTo(g, parent): Promise<void>

Defined in: js-api/src/dapi.ts:591

Adds the group to another one

Parameters

Parameter	Type
g	Group
parent	Group

Returns

Promise<void>

---

list()

list(options?): Promise<Group[]>

Defined in: js-api/src/dapi.ts:318

Returns all entities that satisfy the filtering criteria (see filter). See examples: https://public.datagrok.ai/js/samples/dapi/projects-list Smart filter: https://datagrok.ai/help/datagrok/smart-search

Parameters

Parameter	Type
options	{ filter?: string; order?: string; pageNumber?: number; pageSize?: number; }
options.filter?	string
options.order?	string
options.pageNumber?	number
options.pageSize?	number

Returns

Promise<Group[]>

Inherited from

HttpDataSource.list

---

nextPage()

nextPage(): HttpDataSource<Group>

Defined in: js-api/src/dapi.ts:381

Returns next page of all entities that satisfy the filtering criteria (see filter). Works only if pageSize was set during previous list() call See examples: https://public.datagrok.ai/js/samples/dapi/projects-list

Returns

HttpDataSource<Group>

Inherited from

HttpDataSource.nextPage

---

order()

order(fieldName, desc?): HttpDataSource<Group>

Defined in: js-api/src/dapi.ts:396

Instructs data source to return results in the specified order.

Parameters

Parameter	Type	Default value
fieldName	string	undefined
desc	boolean	false

Returns

HttpDataSource<Group>

Inherited from

HttpDataSource.order

---

page()

page(i): HttpDataSource<Group>

Defined in: js-api/src/dapi.ts:373

Restricts results to the specified page number. See also nextPage.

Parameters

Parameter	Type
i	number

Returns

HttpDataSource<Group>

Inherited from

HttpDataSource.page

---

removeMember()

removeMember(g, m): Promise<void>

Defined in: js-api/src/dapi.ts:584

Removes a member from the group

Parameters

Parameter	Type
g	Group
m	Group

Returns

Promise<void>

---

requestMembership()

requestMembership(group, requester): Promise<void>

Defined in: js-api/src/dapi.ts:630

Requests that requester be added as a member of group. An admin of group must approve before the membership takes effect.

Parameters

Parameter	Type
group	Group
requester	Group

Returns

Promise<void>

---

save()

save(e): Promise<Group>

Defined in: js-api/src/dapi.ts:352

Saves an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise<Group>

Inherited from

HttpDataSource.save

---

saveRelations()

saveRelations(e): Promise<Group>

Defined in: js-api/src/dapi.ts:614

Saves a group with relations

Parameters

Parameter	Type
e	Group

Returns

Promise<Group>

• Group.