ProjectsDataSource
Functionality for working with remote projects
Extends
Constructors
new ProjectsDataSource()
new ProjectsDataSource(
s
,clsName
):ProjectsDataSource
Parameters
Parameter | Type |
---|---|
s | any |
clsName | string |
Returns
Overrides
Constructs
TablesDataSource
Source
Properties
Property | Type | Inherited from |
---|---|---|
clsName | string | HttpDataSource .clsName |
dart | any | HttpDataSource .dart |
Accessors
recent
get
recent():HttpDataSource
<Project
>
Gets recent projects datasource
Returns
Source
Methods
allPackageVersions()
allPackageVersions():
HttpDataSource
<Project
>
Turns off package versions isolation. This DataSource will return all entities in all versions, not only the current one *
Returns
Inherited from
HttpDataSource
. allPackageVersions
Source
by()
by(
i
):HttpDataSource
<Project
>
Parameters
Parameter | Type |
---|---|
i | number |
Returns
Inherited from
Source
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
Source
delete()
delete(
e
):Promise
<void
>
Deletes an entity.
Parameters
Parameter | Type |
---|---|
e | Entity |
Returns
Promise
<void
>
Inherited from
Source
filter()
filter(
w
):HttpDataSource
<Project
>
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
Inherited from
Source
find()
find(
id
):Promise
<Project
>
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
<Project
>
{Promise<object>}
- entity.
Inherited from
Source
first()
first():
Promise
<Project
>
Returns fist entity that satisfies the filtering criteria (see filter).
Returns
Promise
<Project
>
Promise<object>
Inherited from
Source
include()
include(
include
):HttpDataSource
<Project
>
Includes entity in the result
Parameters
Parameter | Type | Description |
---|---|---|
include | string |
Returns
Inherited from
Source
list()
list(
options
):Promise
<Project
[]>
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
<Project
[]>
Inherited from
Source
nextPage()
nextPage():
HttpDataSource
<Project
>
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
Inherited from
Source
open()
open(
name
,options
?):Promise
<Project
>
Opens the specified project.
Parameters
Parameter | Type |
---|---|
name | string |
options ? | ProjectOpenOptions |
Returns
Promise
<Project
>
Source
order()
order(
fieldName
,desc
):HttpDataSource
<Project
>
Instructs data source to return results in the specified order.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
fieldName | string | undefined | |
desc | boolean | false |
Returns
Inherited from
Source
page()
page(
i
):HttpDataSource
<Project
>
Restricts results to the specified page number. See also nextPage.
Parameters
Parameter | Type |
---|---|
i | number |
Returns
Inherited from
Source
save()
save(
e
,options
?):Promise
<Project
>
Saves the Project
Parameters
Parameter | Type |
---|---|
e | Entity |
options ? | object |
options.saveRelations ? | boolean |
Returns
Promise
<Project
>