Class ActionMenuApi

Hierarchy

BaseAPI
- ActionMenuApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new ActionMenuApi(configuration?: Configuration): ActionMenuApi

Inherited from BaseAPI.constructor
- Defined in client/runtime.ts:24
Parameters
- configuration: Configuration = ...
Returns ActionMenuApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

actionMenuConnIdClosePost

actionMenuConnIdClosePost(requestParameters: ActionMenuConnIdClosePostRequest): Promise<object>

- Defined in client/apis/ActionMenuApi.ts:88
Close the active menu associated with a connection

Parameters
- requestParameters: ActionMenuConnIdClosePostRequest
Returns Promise<object>

actionMenuConnIdClosePostRaw

actionMenuConnIdClosePostRaw(requestParameters: ActionMenuConnIdClosePostRequest): Promise<ApiResponse<object>>

- Defined in client/apis/ActionMenuApi.ts:55
Close the active menu associated with a connection

Parameters
- requestParameters: ActionMenuConnIdClosePostRequest
Returns Promise<ApiResponse<object>>

actionMenuConnIdFetchPost

actionMenuConnIdFetchPost(requestParameters: ActionMenuConnIdFetchPostRequest): Promise<ActionMenuFetchResult>

- Defined in client/apis/ActionMenuApi.ts:133
Fetch the active menu

Parameters
- requestParameters: ActionMenuConnIdFetchPostRequest
Returns Promise<ActionMenuFetchResult>

actionMenuConnIdFetchPostRaw

actionMenuConnIdFetchPostRaw(requestParameters: ActionMenuConnIdFetchPostRequest): Promise<ApiResponse<ActionMenuFetchResult>>

- Defined in client/apis/ActionMenuApi.ts:98
Fetch the active menu

Parameters
- requestParameters: ActionMenuConnIdFetchPostRequest
Returns Promise<ApiResponse<ActionMenuFetchResult>>

actionMenuConnIdPerformPost

actionMenuConnIdPerformPost(requestParameters: ActionMenuConnIdPerformPostRequest): Promise<object>

- Defined in client/apis/ActionMenuApi.ts:179
Perform an action associated with the active menu

Parameters
- requestParameters: ActionMenuConnIdPerformPostRequest
Returns Promise<object>

actionMenuConnIdPerformPostRaw

actionMenuConnIdPerformPostRaw(requestParameters: ActionMenuConnIdPerformPostRequest): Promise<ApiResponse<object>>

- Defined in client/apis/ActionMenuApi.ts:143
Perform an action associated with the active menu

Parameters
- requestParameters: ActionMenuConnIdPerformPostRequest
Returns Promise<ApiResponse<object>>

actionMenuConnIdRequestPost

actionMenuConnIdRequestPost(requestParameters: ActionMenuConnIdRequestPostRequest): Promise<object>

- Defined in client/apis/ActionMenuApi.ts:224
Request the active menu

Parameters
- requestParameters: ActionMenuConnIdRequestPostRequest
Returns Promise<object>

actionMenuConnIdRequestPostRaw

actionMenuConnIdRequestPostRaw(requestParameters: ActionMenuConnIdRequestPostRequest): Promise<ApiResponse<object>>

- Defined in client/apis/ActionMenuApi.ts:191
Request the active menu

Parameters
- requestParameters: ActionMenuConnIdRequestPostRequest
Returns Promise<ApiResponse<object>>

actionMenuConnIdSendMenuPost

actionMenuConnIdSendMenuPost(requestParameters: ActionMenuConnIdSendMenuPostRequest): Promise<object>

- Defined in client/apis/ActionMenuApi.ts:272
Send an action menu to a connection

Parameters
- requestParameters: ActionMenuConnIdSendMenuPostRequest
Returns Promise<object>

actionMenuConnIdSendMenuPostRaw

actionMenuConnIdSendMenuPostRaw(requestParameters: ActionMenuConnIdSendMenuPostRequest): Promise<ApiResponse<object>>

- Defined in client/apis/ActionMenuApi.ts:236
Send an action menu to a connection

Parameters
- requestParameters: ActionMenuConnIdSendMenuPostRequest
Returns Promise<ApiResponse<object>>

Protected request

request(context: RequestOpts): Promise<Response>

Inherited from BaseAPI.request
- Defined in client/runtime.ts:50
Parameters
- context: RequestOpts
Returns Promise<Response>

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

Inherited from BaseAPI.withMiddleware
- Defined in client/runtime.ts:28
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]): T

Inherited from BaseAPI.withPostMiddleware
- Defined in client/runtime.ts:42
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]
Returns T

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]): T

Inherited from BaseAPI.withPreMiddleware
- Defined in client/runtime.ts:34
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]
Returns T

Generated using TypeDoc