org.appformer.kogito.bridge.client.guided.tour.service

Interface GuidedTourService

All Known Implementing Classes:

GuidedTourServiceEnvelope

public interface GuidedTourService

Service to access Guided Tour features.

Field Summary

Fields

Modifier and Type	Field and Description
static GuidedTourService	DEFAULT It's the default implementation of the GuidedTourService.

Method Summary

Modifier and Type	Method and Description
boolean	isEnabled() Checks if the Guided Tour is enabled.
void	refresh(UserInteraction userInteraction) Refreshes the Guided Tour with a new user interaction.
void	registerTutorial(Tutorial tutorial) Registers a tutorial into the Guided Tour

Field Detail

DEFAULT

static final GuidedTourService DEFAULT

It's the default implementation of the GuidedTourService.

Method Detail

refresh

void refresh(UserInteraction userInteraction)

Refreshes the Guided Tour with a new user interaction. Thus, depending of the user interaction, the Guided Tour may react or do not react upon a given user interaction.

Parameters:

userInteraction - an user interaction

registerTutorial

void registerTutorial(Tutorial tutorial)

Registers a tutorial into the Guided Tour

Parameters:

tutorial - a tutorial

isEnabled

boolean isEnabled()

Checks if the Guided Tour is enabled.

Returns:

'true' when the Guided Tour is enabled, otherwise it returns 'false'