kient / EventAPI

Class: EventAPI

src/api/events/index.ts:10

Description placeholder

Extends

• APIBase

Constructors

new EventAPI()

new EventAPI(kient): EventAPI

src/api/api-base.ts:7

Parameters

Parameter	Type
kient	Kient

Returns

EventAPI

Inherited from

APIBase.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
kient	readonly	Kient	APIBase.kient	src/api/api-base.ts:5

Methods

getSubscriptions()

getSubscriptions(): Promise<DetailedEventSubscription[]>

src/api/events/index.ts:14

Returns an array of events that are currently subscribed to

Returns

Promise<DetailedEventSubscription[]>

---

subscribe()

subscribe(params): Promise<EventSubscription[]>

src/api/events/index.ts:21

Subscribes to a specific event and returns details about subscription

Parameters

Parameter	Type
params	EventSubscriptionParams

Returns

Promise<EventSubscription[]>

---

unsubscribe()

unsubscribe(ids): Promise<void>

src/api/events/index.ts:28

Unsubscribes to an array of subscription IDs

Parameters

Parameter	Type
ids	string[]

Returns

Promise<void>