UsersDataSource

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

Functionality for handling Users collection from server and working with Users remote endpoint Allows to load current user and list of all Datagrok users with filtering and pagination See example: https://public.datagrok.ai/js/samples/dapi/who-am-i

Extends

• HttpDataSource<User>

Constructors

Constructor

new UsersDataSource(s): UsersDataSource

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

Parameters

Parameter	Type
s	any

Returns

UsersDataSource

Overrides

HttpDataSource.constructor

Properties

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

Accessors

notifications

Get Signature

get notifications(): NotificationsDataSource

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

Notifications API endpoint

Returns

NotificationsDataSource

Methods

allPackageVersions()

allPackageVersions(): this

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

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:419

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:385

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

---

current()

current(): Promise<User>

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

Returns current user

Returns

Promise<User>

---

currentSession()

currentSession(): Promise<UserSession>

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

Returns current session

Returns

Promise<UserSession>

---

delete()

delete(e): Promise<void>

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

Deletes an entity.

Parameters

Parameter	Type
e	DartObject

Returns

Promise<void>

Inherited from

HttpDataSource.delete

---

filter()

filter(w): this

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

A source filtered by [w]; replaces the filter of this source, if any. 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/concepts/objects#entity-search

Parameters

Parameter	Type
w	string

Returns

this

Inherited from

HttpDataSource.filter

---

find()

find(id): Promise<User>

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

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<User>

{Promise<object>} - entity.

Inherited from

HttpDataSource.find

---

first()

first(): Promise<User>

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

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

Returns

Promise<User>

Inherited from

HttpDataSource.first

---

include()

include(include): this

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

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

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

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

Inherited from

HttpDataSource.list

---

nextPage()

nextPage(): this

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

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

---

order()

order(fieldName, desc?): this

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

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:424

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

Parameters

Parameter	Type
i	number

Returns

this

Inherited from

HttpDataSource.page

---

save()

save(e): Promise<User>

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

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

Parameters

Parameter	Type
e	DartObject

Returns

Promise<User>

Inherited from

HttpDataSource.save

---

with()

protected with(patch): this

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

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