Overview
The ContextualContainer class is the backbone of GuideBlocks and needs to be subclassed by your component in order to be used by the Contextual SDK.
Convenience Methods¶
There are a few convenience methods provided by the base class so that you can easily dismiss a guide, proceed to the next step of the guide, go back to the previous step of the guide (if any) and tap inside of or tap outside of the guide (the consequences of which are configured on the Contextual Dashboard on a per guide basis)
| Method | Description |
|---|---|
prevStep |
Informs the Contextual SDK that it should go back to the previous step of the guide |
nextStep |
Informs the Contextual SDK that it should go back to the next step of the guide |
dismissGuide |
Informs the Contextual SDK that it should dismiss the guide |
clickInside |
Informs the Contextual SDK that the guide has been tapped inside and it should perform whatever was configured on the "Tap inside" section of the Dashboard for this guide |
clickOutside |
Informs the Contextual SDK that the guide has been tapped outside of the guide container and it should perform whatever was configured on the "Tap outside" section of the Dashboard for this guide |
complete |
Informs the Contextual SDK that the guide has been completed |
Last update:
2024-02-08