GroupsDataSource

Functionality for handling groups collection from server Allows to manage Group

Extends

• HttpDataSource <Group>

Constructors

new GroupsDataSource()

new GroupsDataSource(s, clsName): GroupsDataSource

Parameters

Parameter	Type
s	any
clsName	string

Returns

GroupsDataSource

Overrides

HttpDataSource . constructor

Constructs

CredentialsDataSource

Source

src/dapi.ts:472

Properties

Property	Type	Inherited from
clsName	string	HttpDataSource.clsName
dart	any	HttpDataSource.dart

Methods

addAdminMember()

addAdminMember(g, m): Promise<void>

Adds an admin member to the group

Parameters

Parameter	Type	Description
g	Group
m	Group

Returns

Promise<void>

Source

src/dapi.ts:507

---

addMember()

addMember(g, m): Promise<void>

Adds a member to the group

Parameters

Parameter	Type	Description
g	Group
m	Group

Returns

Promise<void>

Source

src/dapi.ts:497

---

allPackageVersions()

allPackageVersions(): HttpDataSource <Group>

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

Source

src/dapi.ts:323

---

by()

by(i): HttpDataSource <Group>

Parameters

Parameter	Type
i	number

Returns

HttpDataSource <Group>

Inherited from

HttpDataSource . by

Source

src/dapi.ts:328

---

count()

count(): Promise<number>

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

Source

src/dapi.ts:293

---

createNew()

createNew(name): Promise <Group>

Creates a new group

Parameters

Parameter	Type	Description
name	string

Returns

Promise <Group>

• Group.

Source

src/dapi.ts:481

---

delete()

delete(e): Promise<void>

Deletes an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise<void>

Inherited from

HttpDataSource . delete

Source

src/dapi.ts:318

---

excludeFrom()

excludeFrom(g, parent): Promise<void>

Removes a membership from the group

Parameters

Parameter	Type	Description
g	Group
parent	Group

Returns

Promise<void>

Source

src/dapi.ts:548

---

filter()

filter(w): HttpDataSource <Group>

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/smart-search

Parameters

Parameter	Type	Description
w	string

Returns

HttpDataSource <Group>

Inherited from

HttpDataSource . filter

Source

src/dapi.ts:354

---

find()

find(id): Promise <Group>

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

Source

src/dapi.ts:308

---

first()

first(): Promise <Group>

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

Returns

Promise <Group>

Promise<object>

Inherited from

HttpDataSource . first

Source

src/dapi.ts:299

---

getGroupsLookup()

getGroupsLookup(name): Promise <Group[]>

Looking for groups with similar name

Parameters

Parameter	Type
name	string

Returns

Promise <Group[]>

Source

src/dapi.ts:562

---

getUser()

getUser(group): Promise <Group>

Returns group user

Parameters

Parameter	Type	Description
group	Group

Returns

Promise <Group>

• Group.

Source

src/dapi.ts:489

---

include()

include(include): HttpDataSource <Group>

Includes entity in the result

Parameters

Parameter	Type	Description
include	string

Returns

HttpDataSource <Group>

Inherited from

HttpDataSource . include

Source

src/dapi.ts:371

---

includeAdminTo()

includeAdminTo(g, parent): Promise<void>

Adds the group to another one as admin

Parameters

Parameter	Type	Description
g	Group
parent	Group

Returns

Promise<void>

Source

src/dapi.ts:538

---

includeTo()

includeTo(g, parent): Promise<void>

Adds the group to another one

Parameters

Parameter	Type	Description
g	Group
parent	Group

Returns

Promise<void>

Source

src/dapi.ts:527

---

list()

list(options): Promise <Group[]>

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	object
options.filter?	string
options.order?	string
options.pageNumber?	number
options.pageSize?	number

Returns

Promise <Group[]>

Inherited from

HttpDataSource . list

Source

src/dapi.ts:278

---

nextPage()

nextPage(): HttpDataSource <Group>

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

Source

src/dapi.ts:343

---

order()

order(fieldName, desc): HttpDataSource <Group>

Instructs data source to return results in the specified order.

Parameters

Parameter	Type	Default value	Description
fieldName	string	undefined
desc	boolean	false

Returns

HttpDataSource <Group>

Inherited from

HttpDataSource . order

Source

src/dapi.ts:363

---

page()

page(i): HttpDataSource <Group>

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

Parameters

Parameter	Type
i	number

Returns

HttpDataSource <Group>

Inherited from

HttpDataSource . page

Source

src/dapi.ts:334

---

removeMember()

removeMember(g, m): Promise<void>

Removes a member from the group

Parameters

Parameter	Type	Description
g	Group
m	Group

Returns

Promise<void>

Source

src/dapi.ts:517

---

save()

save(e): Promise <Group>

Saves an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise <Group>

Inherited from

HttpDataSource . save

Source

src/dapi.ts:313

---

saveRelations()

saveRelations(e): Promise <Group>

Saves a group with relations

Parameters

Parameter	Type	Description
e	Group

Returns

Promise <Group>

• Group.

Source

src/dapi.ts:557