remove method
- int overlayId
Remove an overlay from the collection.
Parameters
overlayId: The overlay UID to remove.
Returns
- GemError.success when removal succeeded.
- GemError.notFound when the overlay was not present.
See also:
- OverlayInfo.uid - Retrieve the unique identifier of an overlay.
- contains - Check for a specific OverlayInfo within the collection.
- removeCategory - Remove a category (by id) from an overlay in the collection.
Implementation
GemError remove(final int overlayId) {
final OperationResult resultString = objectMethod(
pointerId,
'OverlayMutableCollection',
'remove',
args: overlayId,
);
return GemErrorExtension.fromCode(resultString['result']);
}