isOverlayEnabled static method

bool isOverlayEnabled(int uid, { int categUid = -1, })

Check whether an overlay (or a category) is currently enabled.

Parameters

• uid: The overlay UID.
• categUid: Optional category UID. When -1 the check targets the whole overlay.

Returns

• True when enabled, false otherwise.

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.
• disableOverlay - Disable an overlay or category globally.

Implementation

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

  return resultString['result'];
}