Class: GroupsDataSource
dg.GroupsDataSource
Functionality for handling groups collection from server Allows to manage Group
Hierarchy
↳
GroupsDataSource
Constructors
constructor
• new GroupsDataSource(s
, clsName
)
Constructs
CredentialsDataSource
Parameters
Name | Type |
---|---|
s | any |
clsName | string |
Overrides
Defined in
Properties
clsName
• clsName: string
Inherited from
Defined in
dart
• dart: any
Inherited from
Defined in
Methods
addAdminMember
▸ addAdminMember(g
, m
): Promise
<void
>
Adds an admin member to the group
Parameters
Name | Type |
---|---|
g | Group |
m | Group |
Returns
Promise
<void
>
Defined in
addMember
▸ addMember(g
, m
): Promise
<void
>
Adds a member to the group
Parameters
Name | Type |
---|---|
g | Group |
m | Group |
Returns
Promise
<void
>
Defined in
allPackageVersions
▸ allPackageVersions(): HttpDataSource
<Group
>
Turns off package versions isolation. This DataSource will return all entities in all versions, not only the current one *
Returns
Inherited from
HttpDataSource.allPackageVersions
Defined in
by
▸ by(i
): HttpDataSource
<Group
>
Parameters
Name | Type |
---|---|
i | number |
Returns
Inherited from
Defined in
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
Defined in
createNew
▸ createNew(name
): Promise
<Group
>
Creates a new group
Parameters
Name | Type |
---|---|
name | string |
Returns
Promise
<Group
>
- Group.
Defined in
delete
▸ delete(e
): Promise
<void
>
Deletes an entity.
Parameters
Name | Type |
---|---|
e | Entity |
Returns
Promise
<void
>
Inherited from
Defined in
excludeFrom
▸ excludeFrom(g
, parent
): Promise
<void
>
Removes a membership from the group
Parameters
Name | Type |
---|---|
g | Group |
parent | Group |
Returns
Promise
<void
>
Defined in
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
Name | Type |
---|---|
w | string |
Returns
Inherited from
Defined in
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
Name | Type | Description |
---|---|---|
id | string | GUID of the corresponding object |
Returns
Promise
<Group
>
{Promise<object>}
- entity.
Inherited from
Defined in
first
▸ first(): Promise
<Group
>
Returns fist entity that satisfies the filtering criteria (see filter).
Returns
Promise
<Group
>
Promise<object>
Inherited from
Defined in
getGroupsLookup
▸ getGroupsLookup(name
): Promise
<Group
[]>
Looking for groups with similar name
Parameters
Name | Type |
---|---|
name | string |
Returns
Promise
<Group
[]>
Defined in
getUser
▸ getUser(group
): Promise
<Group
>
Returns group user
Parameters
Name | Type |
---|---|
group | Group |
Returns
Promise
<Group
>
- Group.
Defined in
include
▸ include(include
): HttpDataSource
<Group
>
Includes entity in the result
Parameters
Name | Type |
---|---|
include | string |
Returns
Inherited from
Defined in
includeAdminTo
▸ includeAdminTo(g
, parent
): Promise
<void
>
Adds the group to another one as admin
Parameters
Name | Type |
---|---|
g | Group |
parent | Group |
Returns
Promise
<void
>
Defined in
includeTo
▸ includeTo(g
, parent
): Promise
<void
>
Adds the group to another one
Parameters
Name | Type |
---|---|
g | Group |
parent | Group |
Returns
Promise
<void
>
Defined in
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
Name | Type |
---|---|
options | Object |
options.filter? | string |
options.order? | string |
options.pageNumber? | number |
options.pageSize? | number |
Returns
Promise
<Group
[]>
Inherited from
Defined in
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
Inherited from
Defined in
order
▸ order(fieldName
, desc?
): HttpDataSource
<Group
>
Instructs data source to return results in the specified order.
Parameters
Name | Type | Default value |
---|---|---|
fieldName | string | undefined |
desc | boolean | false |
Returns
Inherited from
Defined in
page
▸ page(i
): HttpDataSource
<Group
>
Restricts results to the specified page number. See also nextPage.
Parameters
Name | Type |
---|---|
i | number |
Returns
Inherited from
Defined in
removeMember
▸ removeMember(g
, m
): Promise
<void
>
Removes a member from the group
Parameters
Name | Type |
---|---|
g | Group |
m | Group |
Returns
Promise
<void
>
Defined in
save
▸ save(e
): Promise
<Group
>
Saves an entity.
Parameters
Name | Type |
---|---|
e | Entity |
Returns
Promise
<Group
>
Inherited from
Defined in
saveRelations
▸ saveRelations(e
): Promise
<Group
>
Saves a group with relations
Parameters
Name | Type |
---|---|
e | Group |
Returns
Promise
<Group
>
- Group.