Skip to content

Function: requestUserAction()

ts
function requestUserAction(ctx: Context, options: RequestUserActionOptions): Promise<any>;

Defined in: src/renderer/templates/requestUserAction.ts:51

Displays a message and waits for user to complete an action.

Shows dialog with disabled button until successCondition resolves. Proceeds automatically when the condition is met.

Parameters

ParameterTypeDescription
ctxContextRender context
optionsRequestUserActionOptionsDialog configuration

Returns

Promise<any>

Promise resolving when condition is met

Example

ts
import {requestUserAction} from '@matterway/sdk/UI';

await requestUserAction(ctx, {
  title: 'Navigate to Cart',
  text: 'Please go to the Shopping Cart page to continue.',
  successCondition: () => page.waitForSelector('#cart', {timeout: 0})
});

Matterway Assistant SDK Documentation