@acceleratxr/core_sdk / SnapshotService
Class: SnapshotService#
Hierarchy#
-
↳ SnapshotService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new SnapshotService(apiClient: ApiClient, config: Configuration): SnapshotService
Overrides ServiceBase.constructor
Defined in src/services/SnapshotService.ts:10
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: SnapshotService
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 = “24a4143b-b1f9-4a3b-a902-980b6c883f54”
Defined in src/services/SnapshotService.ts:16
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/SnapshotService.ts:33
Returns the count of snapshots
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/SnapshotService.ts:65
Deletes the file
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<Snapshot[] | undefined>
Defined in src/services/SnapshotService.ts:21
Returns all snapshots from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Snapshot[] | undefined>
findById#
▸ findById(id: string): Promise<Snapshot | undefined>
Defined in src/services/SnapshotService.ts:52
Returns a single snapshot from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Snapshot | undefined>
truncate#
▸ truncate(query?: any): Promise<void>
Defined in src/services/SnapshotService.ts:78
Deletes all roles from the service.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<void>