showOverlay static method

Future<void> showOverlay({ int height = WindowSize.fullCover, int width = WindowSize.matchParent, OverlayAlignment alignment = OverlayAlignment.center, NotificationVisibility visibility = NotificationVisibility.visibilitySecret, OverlayFlag flag = OverlayFlag.defaultFlag, String overlayTitle = "overlay activated", String? overlayContent, bool enableDrag = false, PositionGravity positionGravity = PositionGravity.none, OverlayPosition? startPosition, })

Open overLay content

• Optional arguments:

height the overlay height and default is WindowSize.fullCover

width the overlay width and default is WindowSize.matchParent

alignment the alignment postion on screen and default is OverlayAlignment.center

visibilitySecret the detail displayed in notifications on the lock screen and default is NotificationVisibility.visibilitySecret

OverlayFlag the overlay flag and default is OverlayFlag.defaultFlag

overlayTitle the notification message and default is "overlay activated"

overlayContent the notification message

enableDrag to enable/disable dragging the overlay over the screen and default is "false"

positionGravity the overlay postion after drag and default is PositionGravity.none

startPosition the overlay start position and default is null

Implementation

static Future<void> showOverlay({
  int height = WindowSize.fullCover,
  int width = WindowSize.matchParent,
  OverlayAlignment alignment = OverlayAlignment.center,
  NotificationVisibility visibility = NotificationVisibility.visibilitySecret,
  OverlayFlag flag = OverlayFlag.defaultFlag,
  String overlayTitle = "overlay activated",
  String? overlayContent,
  bool enableDrag = false,
  PositionGravity positionGravity = PositionGravity.none,
  OverlayPosition? startPosition,
}) async {
  await _channel.invokeMethod(
    'showOverlay',
    {
      "height": height,
      "width": width,
      "alignment": alignment.name,
      "flag": flag.name,
      "overlayTitle": overlayTitle,
      "overlayContent": overlayContent,
      "enableDrag": enableDrag,
      "notificationVisibility": visibility.name,
      "positionGravity": positionGravity.name,
      "startPosition": startPosition?.toMap(),
    },
  );
}