EventsApi | byu-event-hub-sdk

EventsApi - object-oriented interface

Hierarchy

BaseAPI
- EventsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new EventsApi(fetch?: FetchAPI, basePath?: string): EventsApi

Inherited from BaseAPI.constructor
- Defined in api.ts:31
Parameters
- Default value fetch: FetchAPI = isomorphicFetch
- Default value basePath: string = BASE_PATH
Returns EventsApi

Properties

basePath

basePath: string

fetch

fetch: FetchAPI

Methods

acknowledgeEvent

acknowledgeEvent(params: object, options?: any): Promise<any>

- Defined in api.ts:1506
Acknowledge an event

Parameters
- params: object
  - eventID: string
  - Optional single?: boolean
- Optional options: any
Returns Promise<any>

acknowledgeEventDelete

acknowledgeEventDelete(params: object, options?: any): Promise<any>

- Defined in api.ts:1514
Acknowledge an event

Parameters
- params: object
  - eventID: string
- Optional options: any
Returns Promise<any>

createEvent

createEvent(params: object, options?: any): Promise<any>

- Defined in api.ts:1522
Create a new event

Parameters
- params: object
  - body: Body2
- Optional options: any
Returns Promise<any>

eventOptions

eventOptions(params: object, options?: any): Promise<string[]>

- Defined in api.ts:1530
What can this endpoint do?

Parameters
- params: object
  - eventID: string
- Optional options: any
Returns Promise<string[]>

eventsOptions

eventsOptions(options?: any): Promise<any>

- Defined in api.ts:1537
What can this endpoint do?

Parameters
- Optional options: any
Returns Promise<any>

getEvents

getEvents(params: object, options?: any): Promise<InlineResponse200>

- Defined in api.ts:1545
Retrieve a collection of events

Parameters
- params: object
  - Optional count?: number
- Optional options: any
Returns Promise<InlineResponse200>