CredentialsDataSource
Functionality for handling credentials collection from server and working with credentials remote endpoint Allows to manage Credentials See also: https://datagrok.ai/help/datagrok/solutions/enterprise/security#credentials
Extends
Constructors
new CredentialsDataSource()
new CredentialsDataSource(
s):CredentialsDataSource
Parameters
| Parameter | Type |
|---|---|
s | any |
Returns
Overrides
Constructs
CredentialsDataSource
Source
Properties
| Property | Type | Inherited from |
|---|---|---|
clsName | string | HttpDataSource.clsName |
dart | any | HttpDataSource.dart |
Methods
allPackageVersions()
allPackageVersions():
HttpDataSource<Credentials>
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<Credentials>
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<Credentials>
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
Inherited from
Source
find()
find(
id):Promise<Credentials>
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 <Credentials>
{Promise<object>} - entity.
Inherited from
Source
first()
first():
Promise<Credentials>
Returns fist entity that satisfies the filtering criteria (see filter).
Returns
Promise <Credentials>
Inherited from
Source
forEntity()
forEntity(
e):Promise<Credentials>
Returns credentials for entity
Parameters
| Parameter | Type |
|---|---|
e | Entity |
Returns
Promise <Credentials>
Source
include()
include(
include):HttpDataSource<Credentials>
Includes entity in the result
Parameters
| Parameter | Type |
|---|---|
include | string |
Returns
Inherited from
Source
list()
list(
options):Promise<Credentials[]>
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 <Credentials[]>
Inherited from
Source
nextPage()
nextPage():
HttpDataSource<Credentials>
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
order()
order(
fieldName,desc):HttpDataSource<Credentials>
Instructs data source to return results in the specified order.
Parameters
| Parameter | Type | Default value |
|---|---|---|
fieldName | string | undefined |
desc | boolean | false |
Returns
Inherited from
Source
page()
page(
i):HttpDataSource<Credentials>
Restricts results to the specified page number. See also nextPage.
Parameters
| Parameter | Type |
|---|---|
i | number |
Returns
Inherited from
Source
save()
save(
c):Promise<Credentials>
Saves a credentials. Note, that in order to work correct, credentials should be connected to other entity that owns them. So the best way to modify Credentials is load by forEntity, change Credentials.parameters and after that call this method.
Parameters
| Parameter | Type |
|---|---|
c | Credentials |
Returns
Promise <Credentials>