@acceleratxr/core_sdk / RestoreService

Class: RestoreService

Hierarchy

• ServiceBase

  ↳ RestoreService

Index

Constructors

• constructor

Properties

• apiClient

• config

• uuid

Methods

• count

• create

• delete

• findAll

• findById

• truncate

Constructors

constructor

+ new RestoreService(apiClient: ApiClient, config: Configuration): RestoreService

Overrides ServiceBase.constructor

Defined in src/services/RestoreService.ts:10

Parameters:

Name	Type
apiClient	ApiClient
config	Configuration

Returns: RestoreService

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 = “3c0a1363-f77d-4fec-8413-a06f9d6d972b”

Defined in src/services/RestoreService.ts:16

Methods

count

▸ count(query?: any): Promise<number>

Defined in src/services/RestoreService.ts:57

Returns the count of restores

Parameters:

Name	Type
query?	any

Returns: Promise<number>

---

create

▸ create(obj: Restore): Promise<Restore | undefined>

Defined in src/services/RestoreService.ts:33

Create a new restore

Parameters:

Name	Type
obj	Restore

Returns: Promise<Restore | undefined>

---

delete

▸ delete(id: string): Promise<void>

Defined in src/services/RestoreService.ts:89

Deletes the restore

Parameters:

Name	Type
id	string

Returns: Promise<void>

---

findAll

▸ findAll(query?: any): Promise<Restore[] | undefined>

Defined in src/services/RestoreService.ts:21

Returns all restores from the system that the user has access to

Parameters:

Name	Type
query?	any

Returns: Promise<Restore[] | undefined>

---

findById

▸ findById(id: string): Promise<Restore | undefined>

Defined in src/services/RestoreService.ts:76

Returns a single restore from the system that the user has access to

Parameters:

Name	Type
id	string

Returns: Promise<Restore | undefined>

---

truncate

▸ truncate(query?: any): Promise<void>

Defined in src/services/RestoreService.ts:45

Deletes all restores from the service.

Parameters:

Name	Type
query?	any

Returns: Promise<void>