SpaceChildrenClient
Client for querying and filtering children of a space. Children can include subspaces (Projects), files (FileInfo), and various entities like scripts, queries, and connections.
Extends
Constructors
new SpaceChildrenClient()
new SpaceChildrenClient(
s):SpaceChildrenClient
Parameters
| Parameter | Type |
|---|---|
s | any |
Returns
Overrides
Source
Properties
| Property | Type | Inherited from |
|---|---|---|
clsName | string | HttpDataSource.clsName |
dart | any | HttpDataSource.dart |
Methods
allPackageVersions()
allPackageVersions():
HttpDataSource<Entity>
Turns off package versions isolation. This DataSource will return all entities in all versions, not only the current one *
Returns
Inherited from
HttpDataSource . allPackageVersions
Source
by()
by(
i):HttpDataSource<Entity>
Parameters
| Parameter | Type |
|---|---|
i | number |
Returns
Inherited from
Source
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
Source
delete()
delete(
e):Promise<void>
Deletes an entity.
Parameters
| Parameter | Type |
|---|---|
e | Entity |
Returns
Promise<void>
Inherited from
Source
filter()
filter(
types,includeLinked):SpaceChildrenClient
Filters the children by entity types and whether to include linked items. By default, only directly owned children are returned (not links).
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
types | string | undefined | Comma-separated list of entity types to include (e.g., 'Script,DataQuery') |
includeLinked | boolean | false | If true, includes linked references in addition to owned children (default: false) |
Returns
A new SpaceChildrenClient with the filter applied
Overrides
Source
find()
find(
id):Promise<Entity>
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 <Entity>
{Promise<object>} - entity.
Inherited from
Source
first()
first():
Promise<Entity>
Returns fist entity that satisfies the filtering criteria (see filter).
Returns
Promise <Entity>
Inherited from
Source
include()
include(
include):HttpDataSource<Entity>
Includes entity in the result
Parameters
| Parameter | Type |
|---|---|
include | string |
Returns
Inherited from
Source
list()
list(
options):Promise<Entity[]>
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 <Entity[]>
Inherited from
Source
nextPage()
nextPage():
HttpDataSource<Entity>
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
Source
order()
order(
fieldName,desc):HttpDataSource<Entity>
Instructs data source to return results in the specified order.
Parameters
| Parameter | Type | Default value |
|---|---|---|
fieldName | string | undefined |
desc | boolean | false |
Returns
Inherited from
Source
page()
page(
i):HttpDataSource<Entity>
Restricts results to the specified page number. See also nextPage.
Parameters
| Parameter | Type |
|---|---|
i | number |
Returns
Inherited from
Source
save()
save(
e):Promise<Entity>
Saves an entity.
Parameters
| Parameter | Type |
|---|---|
e | Entity |
Returns
Promise <Entity>