UsersDataSource

Defined in: src/dapi.ts:360

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: src/dapi.ts:362

Parameters

Parameter	Type
s	any

Returns

UsersDataSource

Overrides

HttpDataSource.constructor

Properties

Property	Type	Inherited from	Defined in
clsName	string	HttpDataSource.clsName	src/dapi.ts:252
dart	any	HttpDataSource.dart	src/dapi.ts:251

Accessors

notifications

Get Signature

get notifications(): NotificationsDataSource

Defined in: src/dapi.ts:367

Notifications API endpoint

Returns

NotificationsDataSource

Methods

allPackageVersions()

allPackageVersions(): HttpDataSource<User>

Defined in: src/dapi.ts:307

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

---

by()

by(i): HttpDataSource<User>

Defined in: src/dapi.ts:312

Parameters

Parameter	Type
i	number

Returns

HttpDataSource<User>

Inherited from

HttpDataSource.by

---

count()

count(): Promise<number>

Defined in: src/dapi.ts:278

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: src/dapi.ts:372

Returns current user

Returns

Promise<User>

---

currentSession()

currentSession(): Promise<UserSession>

Defined in: src/dapi.ts:378

Returns current session

Returns

Promise<UserSession>

---

delete()

delete(e): Promise<void>

Defined in: src/dapi.ts:302

Deletes an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise<void>

Inherited from

HttpDataSource.delete

---

filter()

filter(w): HttpDataSource<User>

Defined in: src/dapi.ts:335

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/navigation/views/browse#entity-search

Parameters

Parameter	Type
w	string

Returns

HttpDataSource<User>

Inherited from

HttpDataSource.filter

---

find()

find(id): Promise<User>

Defined in: src/dapi.ts:292

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: src/dapi.ts:283

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

Returns

Promise<User>

Inherited from

HttpDataSource.first

---

include()

include(include): HttpDataSource<User>

Defined in: src/dapi.ts:347

Includes entity in the result

Parameters

Parameter	Type
include	string

Returns

HttpDataSource<User>

Inherited from

HttpDataSource.include

---

list()

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

Defined in: src/dapi.ts:263

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(): HttpDataSource<User>

Defined in: src/dapi.ts:326

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

---

order()

order(fieldName, desc?): HttpDataSource<User>

Defined in: src/dapi.ts:341

Instructs data source to return results in the specified order.

Parameters

Parameter	Type	Default value
fieldName	string	undefined
desc	boolean	false

Returns

HttpDataSource<User>

Inherited from

HttpDataSource.order

---

page()

page(i): HttpDataSource<User>

Defined in: src/dapi.ts:318

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

Parameters

Parameter	Type
i	number

Returns

HttpDataSource<User>

Inherited from

HttpDataSource.page

---

save()

save(e): Promise<User>

Defined in: src/dapi.ts:297

Saves an entity.

Parameters

Parameter	Type
e	Entity

Returns

Promise<User>

Inherited from

HttpDataSource.save