Skip to main content

Class: UsersDataSource

dg.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

Hierarchy

Constructors

constructor

new UsersDataSource(s)

Constructs

UsersDataSource

Parameters

NameType
sany

Overrides

HttpDataSource.constructor

Defined in

src/dapi.ts:368

Properties

clsName

clsName: string

Inherited from

HttpDataSource.clsName

Defined in

src/dapi.ts:249


dart

dart: any

Inherited from

HttpDataSource.dart

Defined in

src/dapi.ts:248

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

Defined in

src/dapi.ts:305


by

by(i): HttpDataSource<User>

Parameters

NameType
inumber

Returns

HttpDataSource<User>

Inherited from

HttpDataSource.by

Defined in

src/dapi.ts:310


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

Defined in

src/dapi.ts:275


current

current(): Promise<User>

Returns current user

Returns

Promise<User>

Defined in

src/dapi.ts:374


currentSession

currentSession(): Promise<UserSession>

Returns current session

Returns

Promise<UserSession>

Defined in

src/dapi.ts:381


delete

delete(e): Promise<void>

Deletes an entity.

Parameters

NameType
eEntity

Returns

Promise<void>

Inherited from

HttpDataSource.delete

Defined in

src/dapi.ts:300


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

NameType
wstring

Returns

HttpDataSource<User>

Inherited from

HttpDataSource.filter

Defined in

src/dapi.ts:336


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

NameTypeDescription
idstringGUID of the corresponding object

Returns

Promise<User>

{Promise<object>} - entity.

Inherited from

HttpDataSource.find

Defined in

src/dapi.ts:290


first

first(): Promise<User>

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

Returns

Promise<User>

Promise<object>

Inherited from

HttpDataSource.first

Defined in

src/dapi.ts:281


include

include(include): HttpDataSource<User>

Includes entity in the result

Parameters

NameType
includestring

Returns

HttpDataSource<User>

Inherited from

HttpDataSource.include

Defined in

src/dapi.ts:353


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

NameType
optionsObject
options.filter?string
options.order?string
options.pageNumber?number
options.pageSize?number

Returns

Promise<User[]>

Inherited from

HttpDataSource.list

Defined in

src/dapi.ts:260


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

Defined in

src/dapi.ts:325


order

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

Instructs data source to return results in the specified order.

Parameters

NameTypeDefault value
fieldNamestringundefined
descbooleanfalse

Returns

HttpDataSource<User>

Inherited from

HttpDataSource.order

Defined in

src/dapi.ts:345


page

page(i): HttpDataSource<User>

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

Parameters

NameType
inumber

Returns

HttpDataSource<User>

Inherited from

HttpDataSource.page

Defined in

src/dapi.ts:316


save

save(e): Promise<User>

Saves an entity.

Parameters

NameType
eEntity

Returns

Promise<User>

Inherited from

HttpDataSource.save

Defined in

src/dapi.ts:295