getOverlayByUId method

OverlayInfo? getOverlayByUId(
  1. int overlayUid
)

Get the overlay having the specified UID.

Parameters

  • IN overlayUid The overlay UID

Returns

  • Empty if the overlay is not found

Throws

  • An exception if it fails

Implementation

OverlayInfo? getOverlayByUId(final int overlayUid) {
  final OperationResult resultString = objectMethod(
    _pointerId,
    'OverlayCollection',
    'getOverlayByUid',
    args: overlayUid,
  );
  final int id = resultString['result'];

  if (id == -1) {
    return null;
  }

  return OverlayInfo.init(id);
}