Class ActionMenuApi

Hierarchy

BaseAPI
- ActionMenuApi

Index

Constructors

Properties

Methods

actionMenuConnIdClosePost actionMenuConnIdClosePostRaw actionMenuConnIdFetchPost actionMenuConnIdFetchPostRaw actionMenuConnIdPerformPost actionMenuConnIdPerformPostRaw actionMenuConnIdRequestPost actionMenuConnIdRequestPostRaw actionMenuConnIdSendMenuPost actionMenuConnIdSendMenuPostRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

actionMenuConnIdClosePost

actionMenuConnIdClosePost(requestParameters): Promise<object>
Close the active menu associated with a connection
Parameters
- requestParameters: ActionMenuConnIdClosePostRequest
Returns Promise<object>
- Defined in client/apis/ActionMenuApi.ts:88

actionMenuConnIdClosePostRaw

actionMenuConnIdClosePostRaw(requestParameters): Promise<ApiResponse<object>>
Close the active menu associated with a connection
Parameters
- requestParameters: ActionMenuConnIdClosePostRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/ActionMenuApi.ts:55

actionMenuConnIdFetchPost

actionMenuConnIdFetchPost(requestParameters): Promise<ActionMenuFetchResult>
Fetch the active menu
Parameters
- requestParameters: ActionMenuConnIdFetchPostRequest
Returns Promise<ActionMenuFetchResult>
- Defined in client/apis/ActionMenuApi.ts:133

actionMenuConnIdFetchPostRaw

actionMenuConnIdFetchPostRaw(requestParameters): Promise<ApiResponse<ActionMenuFetchResult>>
Fetch the active menu
Parameters
- requestParameters: ActionMenuConnIdFetchPostRequest
Returns Promise<ApiResponse<ActionMenuFetchResult>>
- Defined in client/apis/ActionMenuApi.ts:98

actionMenuConnIdPerformPost

actionMenuConnIdPerformPost(requestParameters): Promise<object>
Perform an action associated with the active menu
Parameters
- requestParameters: ActionMenuConnIdPerformPostRequest
Returns Promise<object>
- Defined in client/apis/ActionMenuApi.ts:179

actionMenuConnIdPerformPostRaw

actionMenuConnIdPerformPostRaw(requestParameters): Promise<ApiResponse<object>>
Perform an action associated with the active menu
Parameters
- requestParameters: ActionMenuConnIdPerformPostRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/ActionMenuApi.ts:143

actionMenuConnIdRequestPost

actionMenuConnIdRequestPost(requestParameters): Promise<object>
Request the active menu
Parameters
- requestParameters: ActionMenuConnIdRequestPostRequest
Returns Promise<object>
- Defined in client/apis/ActionMenuApi.ts:224

actionMenuConnIdRequestPostRaw

actionMenuConnIdRequestPostRaw(requestParameters): Promise<ApiResponse<object>>
Request the active menu
Parameters
- requestParameters: ActionMenuConnIdRequestPostRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/ActionMenuApi.ts:191

actionMenuConnIdSendMenuPost

actionMenuConnIdSendMenuPost(requestParameters): Promise<object>
Send an action menu to a connection
Parameters
- requestParameters: ActionMenuConnIdSendMenuPostRequest
Returns Promise<object>
- Defined in client/apis/ActionMenuApi.ts:272

actionMenuConnIdSendMenuPostRaw

actionMenuConnIdSendMenuPostRaw(requestParameters): Promise<ApiResponse<object>>
Send an action menu to a connection
Parameters
- requestParameters: ActionMenuConnIdSendMenuPostRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/ActionMenuApi.ts:236

`Protected` request

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

withMiddleware

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

withPostMiddleware

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

withPreMiddleware

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

Generated using TypeDoc