@acceleratxr/core_sdk / ResourceService
Class: ResourceService#
Hierarchy#
-
↳ ResourceService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new ResourceService(apiClient: ApiClient, config: Configuration): ResourceService
Overrides ServiceBase.constructor
Defined in src/services/ResourceService.ts:10
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: ResourceService
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 = “6c32d4e0-952f-4f50-9c49-1605b035f1f4”
Defined in src/services/ResourceService.ts:16
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/ResourceService.ts:69
Returns the count of resources
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: Resource): Promise<Resource | undefined>
Defined in src/services/ResourceService.ts:33
Create a new resource
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<Resource | undefined>
createMany#
▸ createMany(objs: Resource[]): Promise<Resource[] | undefined>
Defined in src/services/ResourceService.ts:45
Create a list of new resources
Parameters:#
Name |
Type |
|---|---|
|
Resource[] |
Returns: Promise<Resource[] | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/ResourceService.ts:114
Deletes the resource
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<Resource[] | undefined>
Defined in src/services/ResourceService.ts:21
Returns all resources from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Resource[] | undefined>
findById#
▸ findById(id: string): Promise<Resource | undefined>
Defined in src/services/ResourceService.ts:88
Returns a single resource from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Resource | undefined>
truncate#
▸ truncate(query?: any): Promise<void>
Defined in src/services/ResourceService.ts:57
Deletes all roles from the service.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<void>
update#
▸ update(id: string, obj: Resource): Promise<Resource | undefined>
Defined in src/services/ResourceService.ts:101
Updates a single resource
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<Resource | undefined>