patchbayUiWaitCommandDescriptor top-level property

PatchbayCommandDescriptor patchbayUiWaitCommandDescriptor
final

Implementation

final patchbayUiWaitCommandDescriptor = _ui(
  'ui.wait',
  'Wait for one bounded Flutter observation condition.',
  mode: PatchbayCommandMode.readOnly,
  effect: PatchbaySideEffect.none,
  parameters: <PatchbayParameterDescriptor>[
    _p(
      'condition',
      PatchbayParameterType.enumeration,
      required: true,
      allowedValues: const <String>[
        'semanticsMounted',
        'semanticsUnmounted',
        'semanticsValue',
        'navigationDestination',
        'treeRevision',
        'frameRevision',
      ],
    ),
    _p(
      'timeoutMs',
      PatchbayParameterType.integer,
      required: true,
      defaultValue: 5000,
    ),
    _p('semanticsIdentifier', PatchbayParameterType.string),
    _p('value', PatchbayParameterType.string),
    _p('destinationId', PatchbayParameterType.string),
    _p('revision', PatchbayParameterType.integer),
  ],
  cliSyntax: <PatchbayCliSyntax>[
    _wait(
      'uiWaitSemanticsMounted',
      'semantics-mounted',
      'Wait for a semantics identifier to mount.',
      'semanticsMounted',
      'semanticsIdentifier',
      '<identifier>',
    ),
    _wait(
      'uiWaitSemanticsUnmounted',
      'semantics-unmounted',
      'Wait for a semantics identifier to unmount.',
      'semanticsUnmounted',
      'semanticsIdentifier',
      '<identifier>',
    ),
    _wait2(
      'uiWaitSemanticsValue',
      'semantics-value',
      'Wait for a semantics value.',
      'semanticsValue',
      <String>['semanticsIdentifier', 'value'],
      '<identifier> <value>',
    ),
    _wait(
      'uiWaitDestination',
      'destination',
      'Wait for a navigation destination.',
      'navigationDestination',
      'destinationId',
      '<destination-id>',
      revisionOption: true,
    ),
    _wait(
      'uiWaitTreeRevision',
      'tree-revision',
      'Wait for the semantics tree revision.',
      'treeRevision',
      'revision',
      '<revision>',
      nonNegative: true,
    ),
    _wait(
      'uiWaitFrameRevision',
      'frame-revision',
      'Wait for the rendered frame revision.',
      'frameRevision',
      'revision',
      '<revision>',
      nonNegative: true,
    ),
  ],
);