shouldShowOverlay()
Introduction
The shouldShowOverlay() method allows the SDK to request that your app shows the MaestroOverlay specified by the id parameter.
Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
id | String | The string containing the identifier for the overlay that should be shown. This should be used as the id parameter when instancing the MaestroOverlay. | abc |
buttonSize | Int | The size of the button that will be shown in the overlay. This is provided so the client app can determine where the button should be placed within the overlay. That position should be used as the buttonPosition parameter in instancing the MaestroOverlay. | CGSize(width: 500, height: 100) |
Code Example
// Request that the app shows the overlay
await delegate.shouldShowOverlay(id: "abc", buttonSize: CGSize(width: 500, height: 100))