@acceleratxr/core_sdk / EventService
Class: EventService#
Hierarchy#
-
↳ EventService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new EventService(apiClient: ApiClient, config: Configuration): EventService
Overrides ServiceBase.constructor
Defined in src/services/EventService.ts:10
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: EventService
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 = “746fbf0e-b192-4772-8bcc-49595f3928d8”
Defined in src/services/EventService.ts:16
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/EventService.ts:46
Returns the count of events based on the given criteria.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: Event): Promise<Event | undefined>
Defined in src/services/EventService.ts:33
Creates a new event record in the database.
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<Event | undefined>
findAll#
▸ findAll(query?: any): Promise<Event[] | undefined>
Defined in src/services/EventService.ts:21
Returns all events from the system that the user has access to based upon the given criteria.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Event[] | undefined>
findById#
▸ findById(id: string): Promise<Event | undefined>
Defined in src/services/EventService.ts:65
Returns a single event from the system that the user has access to.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Event | undefined>