@acceleratxr/core_sdk / PersonaService
Class: PersonaService#
Hierarchy#
-
↳ PersonaService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new PersonaService(apiClient: ApiClient, config: Configuration): PersonaService
Overrides ServiceBase.constructor
Defined in src/services/PersonaService.ts:10
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: PersonaService
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 = “1c3089f4-ae04-46a9-b44b-417f917edfa8”
Defined in src/services/PersonaService.ts:15
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/PersonaService.ts:44
Returns the count of personas
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: Persona): Promise<Persona | undefined>
Defined in src/services/PersonaService.ts:32
Create a new persona.
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<Persona | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/PersonaService.ts:89
Deletes the persona
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<Persona[] | undefined>
Defined in src/services/PersonaService.ts:20
Returns all personas from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Persona[] | undefined>
findById#
▸ findById(id: string): Promise<Persona | undefined>
Defined in src/services/PersonaService.ts:63
Returns a single persona from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Persona | undefined>
update#
▸ update(id: string, obj: Persona): Promise<Persona | undefined>
Defined in src/services/PersonaService.ts:76
Updates a single persona
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<Persona | undefined>