@acceleratxr/core_sdk / ScriptService
Class: ScriptService#
Hierarchy#
-
↳ ScriptService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new ScriptService(apiClient: ApiClient, config: Configuration): ScriptService
Overrides ServiceBase.constructor
Defined in src/services/ScriptService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: ScriptService
Properties#
apiClient#
• Protected apiClient: ApiClient
Inherited from ServiceBase.apiClient
Defined in src/ServiceBase.ts:14
The API Client used when making requests to the API backend server.
config#
• Protected config: Configuration
Inherited from ServiceBase.config
Defined in src/ServiceBase.ts:19
The SDK configuration to use.
uuid#
▪ Static uuid: string = “9e8cb1f0-f7cd-49f1-a347-3ea0c61fee50”
Defined in src/services/ScriptService.ts:17
Methods#
count#
▸ count(service: string, query?: any): Promise<number>
Defined in src/services/ScriptService.ts:55
Returns the count of scripts
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<number>
create#
▸ create(service: string, obj: Script): Promise<Script | undefined>
Defined in src/services/ScriptService.ts:41
Create a new script
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<Script | undefined>
createMany#
▸ createMany(service: string, objs: Script[], encoding: Encoding): Promise<Script[] | undefined>
Defined in src/services/ScriptService.ts:224
Create a list of new scripts
Parameters:#
Name |
Type |
Default value |
|---|---|---|
|
string |
- |
|
Script[] |
- |
|
Encoding |
“base64” |
Returns: Promise<Script[] | undefined>
delete#
▸ delete(service: string, id: string): Promise<void>
Defined in src/services/ScriptService.ts:74
Marks the script as deleted.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
Returns: Promise<void>
deleteByIdAndVersion#
▸ deleteByIdAndVersion(service: string, id: string, version: number): Promise<void>
Defined in src/services/ScriptService.ts:87
Marks the script as deleted.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
|
number |
Returns: Promise<void>
findAll#
▸ findAll(service: string, query?: any): Promise<Script[] | undefined>
Defined in src/services/ScriptService.ts:29
Returns all scripts from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<Script[] | undefined>
findById#
▸ findById(service: string, id: string): Promise<Script | undefined>
Defined in src/services/ScriptService.ts:101
Returns a single script from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
Returns: Promise<Script | undefined>
findByIdAndVersion#
▸ findByIdAndVersion(service: string, id: string, version: number): Promise<Script | undefined>
Defined in src/services/ScriptService.ts:114
Returns a single script from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
|
number |
Returns: Promise<Script | undefined>
getDependencies#
▸ getDependencies(service: string): Promise<any>
Defined in src/services/ScriptService.ts:208
Returns the scripting system’s dependencies configuration.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<any>
getScriptsPath#
▸ getScriptsPath(serviceName: string | undefined): string
Defined in src/services/ScriptService.ts:19
Parameters:#
Name |
Type |
Default value |
|---|---|---|
|
string | undefined |
undefined |
Returns: string
publish#
▸ publish(service: string, id: string, version: number): Promise<Script | undefined>
Defined in src/services/ScriptService.ts:128
Marks the script with the given id and version as published, to be executed by the service.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
|
number |
Returns: Promise<Script | undefined>
purge#
▸ purge(service: string, id: string): Promise<void>
Defined in src/services/ScriptService.ts:142
Removes the script from the database.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
Returns: Promise<void>
purgeByIdAndVersion#
▸ purgeByIdAndVersion(service: string, id: string, version: number): Promise<void>
Defined in src/services/ScriptService.ts:155
Removes the script from the database.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
|
number |
Returns: Promise<void>
restore#
▸ restore(service: string, id: string): Promise<Script | undefined>
Defined in src/services/ScriptService.ts:169
Restores a previously deleted script.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
Returns: Promise<Script | undefined>
restoreByIdAndVersion#
▸ restoreByIdAndVersion(service: string, id: string, version: number): Promise<Script | undefined>
Defined in src/services/ScriptService.ts:181
Restores a specific version of a previously deleted script.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
|
number |
Returns: Promise<Script | undefined>
update#
▸ update(service: string, id: string, obj: Script): Promise<Script | undefined>
Defined in src/services/ScriptService.ts:193
Updates a single script
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
|
Returns: Promise<Script | undefined>