@acceleratxr/core_sdk / ProfileService
Class: ProfileService#
Hierarchy#
-
↳ ProfileService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new ProfileService(apiClient: ApiClient, config: Configuration): ProfileService
Overrides ServiceBase.constructor
Defined in src/services/ProfileService.ts:10
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: ProfileService
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 = “8fb00b0b-df8c-45ef-9f56-f3a02f511722”
Defined in src/services/ProfileService.ts:16
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/ProfileService.ts:45
Returns the count of profiles
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: Profile): Promise<Profile | undefined>
Defined in src/services/ProfileService.ts:33
Create a new profile.
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<Profile | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/ProfileService.ts:90
Deletes the profile
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
deleteMyProfile#
▸ deleteMyProfile(): Promise<void>
Defined in src/services/ProfileService.ts:135
Deletes the profile for the logged in user.
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<Profile[] | undefined>
Defined in src/services/ProfileService.ts:21
Returns all profiles from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Profile[] | undefined>
findById#
▸ findById(id: string): Promise<Profile | undefined>
Defined in src/services/ProfileService.ts:64
Returns a single profile from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Profile | undefined>
findMyProfile#
▸ findMyProfile(): Promise<Profile | undefined>
Defined in src/services/ProfileService.ts:103
Returns the profile from the system for the logged in user.
Returns: Promise<Profile | undefined>
update#
▸ update(id: string, obj: Profile): Promise<Profile | undefined>
Defined in src/services/ProfileService.ts:77
Updates a single profile
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<Profile | undefined>
updateMyProfile#
▸ updateMyProfile(obj: Profile): Promise<Profile | undefined>
Defined in src/services/ProfileService.ts:119
Creates or updates the profile for the logged in user.
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<Profile | undefined>