Class: EventsApi
Types.EventsApi
Hierarchy
↳
EventsApi
Constructors
constructor
• new EventsApi(configuration?)
Parameters
| Name | Type | Default value |
|---|---|---|
configuration | Configuration | DefaultConfig |
Inherited from
Methods
postActionsSdk
▸ postActionsSdk(requestParameters, initOverrides?): Promise<void>
Post information that can used to build and publish an event originating from the SlashID SDK Publish an event from the SDK
Parameters
| Name | Type |
|---|---|
requestParameters | PostActionsSdkRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<void>
postActionsSdkRaw
▸ postActionsSdkRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Post information that can used to build and publish an event originating from the SlashID SDK Publish an event from the SDK
Parameters
| Name | Type |
|---|---|
requestParameters | PostActionsSdkRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<ApiResponse<void>>
postEvents
▸ postEvents(requestParameters, initOverrides?): Promise<void>
Post information that can used to build and publish an event. Deprecated, use /actions.
Publish an event
Parameters
| Name | Type |
|---|---|
requestParameters | PostEventsRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<void>
postEventsRaw
▸ postEventsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Post information that can used to build and publish an event. Deprecated, use /actions.
Publish an event
Parameters
| Name | Type |
|---|---|
requestParameters | PostEventsRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<ApiResponse<void>>
withMiddleware
▸ withMiddleware<T>(this, ...middlewares): T
Type parameters
| Name | Type |
|---|---|
T | extends BaseAPI<T> |
Parameters
| Name | Type |
|---|---|
this | T |
...middlewares | Middleware[] |
Returns
T
Inherited from
withPostMiddleware
▸ withPostMiddleware<T>(this, ...postMiddlewares): T
Type parameters
| Name | Type |
|---|---|
T | extends BaseAPI<T> |
Parameters
| Name | Type |
|---|---|
this | T |
...postMiddlewares | (undefined | (context: ResponseContext) => Promise<void | Response>)[] |
Returns
T
Inherited from
withPreMiddleware
▸ withPreMiddleware<T>(this, ...preMiddlewares): T
Type parameters
| Name | Type |
|---|---|
T | extends BaseAPI<T> |
Parameters
| Name | Type |
|---|---|
this | T |
...preMiddlewares | (undefined | (context: RequestContext) => Promise<void | FetchParams>)[] |
Returns
T