disableOverlay static method

GemError disableOverlay(int uid, { int categUid = -1, })

Disable an overlay (or a single category) globally.

Parameters

• uid: The overlay UID to disable.
• categUid: Optional category UID. When -1 the whole overlay is disabled.

Returns

• GemError.success on success.
• GemError.notFound when the overlay (or category) was not found.

See also:

• OverlayInfo.uid - Retrieve the unique identifier of an overlay.
• OverlayCategory.uid - Retrieve the unique identifier of an overlay category.
• enableOverlay - Enable an overlay or category globally.
• isOverlayEnabled - Check whether an overlay or category is enabled.
• CommonOverlayId - Predefined common overlay identifiers.

Implementation

static GemError disableOverlay(final int uid, {final int categUid = -1}) {
  final OperationResult resultString = staticMethod(
    'OverlayService',
    'disableOverlay',
    args: <String, int>{'uid': uid, 'categUid': categUid},
  );

  return GemErrorExtension.fromCode(resultString['result']);
}