SpaceChildrenClient

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

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

• HttpDataSource<Entity>

Constructors

Constructor

new SpaceChildrenClient(s): SpaceChildrenClient

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

Parameters

Parameter	Type
s	any

Returns

SpaceChildrenClient

Overrides

HttpDataSource.constructor

Properties

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

Methods

allPackageVersions()

allPackageVersions(): this

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

A source without package version isolation: entities of all package versions, not only the current one.

Returns

this

Inherited from

HttpDataSource.allPackageVersions

---

by()

by(i): this

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

A source that returns at most [i] entities per page. See also page.

Parameters

Parameter	Type
i	number

Returns

this

Inherited from

HttpDataSource.by

---

count()

count(): Promise<number>

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

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

---

delete()

delete(e): Promise<void>

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

Deletes an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise<void>

Inherited from

HttpDataSource.delete

---

filter()

filter(types, includeLinked?): this

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

Parameters

Parameter	Type	Default value
types	string	undefined
includeLinked	boolean	false

Returns

this

Deprecated

Use ofTypes: unlike HttpDataSource.filter, this takes entity types, not a smart filter. Removed in 1.29.

Overrides

HttpDataSource.filter

---

find()

find(id): Promise<Entity>

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

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

HttpDataSource.find

---

first()

first(): Promise<Entity>

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

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

Returns

Promise<Entity>

Inherited from

HttpDataSource.first

---

include()

include(include): this

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

A source that also loads the [include]d properties of every entity (adds to this source's includes).

Parameters

Parameter	Type
include	string

Returns

this

Inherited from

HttpDataSource.include

---

list()

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

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

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<Entity[]>

Inherited from

HttpDataSource.list

---

nextPage()

nextPage(): this

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

A source for the page after this one (the first call gives page 1). Reassign to advance: source = source.nextPage(). See examples: https://public.datagrok.ai/js/samples/dapi/projects-list

Returns

this

Inherited from

HttpDataSource.nextPage

---

ofTypes()

ofTypes(types, includeLinked?): this

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

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

this

A new SpaceChildrenClient with the filter applied

---

order()

order(fieldName, desc?): this

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

A source ordered by [fieldName]; replaces the order of this source, if any.

Parameters

Parameter	Type	Default value
fieldName	string	undefined
desc	boolean	false

Returns

this

Inherited from

HttpDataSource.order

---

page()

page(i): this

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

A source restricted to page [i]. See also nextPage.

Parameters

Parameter	Type
i	number

Returns

this

Inherited from

HttpDataSource.page

---

save()

save(e): Promise<Entity>

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

Saves an entity; the saved copy comes back with this source's includes loaded.

Parameters

Parameter	Type
e	Entity

Returns

Promise<Entity>

Inherited from

HttpDataSource.save

---

with()

protected with(patch): this

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

A copy of this source whose query has [patch] applied. The Dart handle is shared; its state is rebuilt from the query right before every request, so the copies never observe each other.

Parameters

Parameter	Type
patch	Partial<DataSourceQuery>

Returns

this

Inherited from

HttpDataSource.with