@acceleratxr/core_sdk / ArchetypeDefinitionService
Class: ArchetypeDefinitionService#
Hierarchy#
-
↳ ArchetypeDefinitionService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new ArchetypeDefinitionService(apiClient: ApiClient, config: Configuration): ArchetypeDefinitionService
Overrides ServiceBase.constructor
Defined in src/services/ArchetypeDefinitionService.ts:10
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: ArchetypeDefinitionService
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 = “cb08ffd7-f4cb-484d-8c88-1236b77d954a”
Defined in src/services/ArchetypeDefinitionService.ts:16
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/ArchetypeDefinitionService.ts:57
Returns the count of archetype definitions based on the given criteria.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: ArchetypeDefinition): Promise<ArchetypeDefinition | undefined>
Defined in src/services/ArchetypeDefinitionService.ts:33
Creates a new archetype definition.
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<ArchetypeDefinition | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/ArchetypeDefinitionService.ts:102
Deletes the archetype from the service.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<ArchetypeDefinition[] | undefined>
Defined in src/services/ArchetypeDefinitionService.ts:21
Returns all archetype definitions from the system that the persona has access to based upon the given criteria.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<ArchetypeDefinition[] | undefined>
findById#
▸ findById(id: string): Promise<ArchetypeDefinition | undefined>
Defined in src/services/ArchetypeDefinitionService.ts:76
Returns a single archetype definition from the system that the persona has access to.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<ArchetypeDefinition | undefined>
truncate#
▸ truncate(query?: any): Promise<void>
Defined in src/services/ArchetypeDefinitionService.ts:45
Deletes all archetype definitions from the service.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<void>
update#
▸ update(id: string, obj: ArchetypeDefinition): Promise<ArchetypeDefinition | undefined>
Defined in src/services/ArchetypeDefinitionService.ts:89
Updates a single archetype definition.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<ArchetypeDefinition | undefined>