UsersDataSource

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

new UsersDataSource()

new UsersDataSource(s): UsersDataSource

Parameters

Parameter	Type
s	any

Returns

UsersDataSource

Overrides

HttpDataSource . constructor

Constructs

UsersDataSource

Source

src/dapi.ts:386

Properties

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

Methods

allPackageVersions()

allPackageVersions(): HttpDataSource <User>

Turns off package versions isolation. This DataSource will return all entities in all versions, not only the current one *

Returns

HttpDataSource <User>

Inherited from

HttpDataSource . allPackageVersions

Source

src/dapi.ts:323

---

by()

by(i): HttpDataSource <User>

Parameters

Parameter	Type
i	number

Returns

HttpDataSource <User>

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

---

current()

current(): Promise <User>

Returns current user

Returns

Promise <User>

Source

src/dapi.ts:392

---

currentSession()

currentSession(): Promise <UserSession>

Returns current session

Returns

Promise <UserSession>

Source

src/dapi.ts:399

---

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

---

filter()

filter(w): HttpDataSource <User>

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

Inherited from

HttpDataSource . filter

Source

src/dapi.ts:354

---

find()

find(id): Promise <User>

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

Source

src/dapi.ts:308

---

first()

first(): Promise <User>

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

Returns

Promise <User>

Promise<object>

Inherited from

HttpDataSource . first

Source

src/dapi.ts:299

---

include()

include(include): HttpDataSource <User>

Includes entity in the result

Parameters

Parameter	Type	Description
include	string

Returns

HttpDataSource <User>

Inherited from

HttpDataSource . include

Source

src/dapi.ts:371

---

list()

list(options): Promise <User[]>

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

Inherited from

HttpDataSource . list

Source

src/dapi.ts:278

---

nextPage()

nextPage(): HttpDataSource <User>

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

Inherited from

HttpDataSource . nextPage

Source

src/dapi.ts:343

---

order()

order(fieldName, desc): HttpDataSource <User>

Instructs data source to return results in the specified order.

Parameters

Parameter	Type	Default value	Description
fieldName	string	undefined
desc	boolean	false

Returns

HttpDataSource <User>

Inherited from

HttpDataSource . order

Source

src/dapi.ts:363

---

page()

page(i): HttpDataSource <User>

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

Parameters

Parameter	Type
i	number

Returns

HttpDataSource <User>

Inherited from

HttpDataSource . page

Source

src/dapi.ts:334

---

save()

save(e): Promise <User>

Saves an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise <User>

Inherited from

HttpDataSource . save

Source

src/dapi.ts:313