Comece um guia

Aciona um Guia específico pelo seu ID, iniciando-o para o usuário atual. Se outro Guia estiver sendo reproduzido, ele será interrompido e o guia solicitado será iniciado.

Definição de tipo

 type previewGuide = (
	guideId: number,
	options?: {
		checkHistory?: boolean,
		initialStep?: number,
	}
 ) => void

Parâmetros opcionais:

• initialStep (número) – O número da etapa a partir da qual o Guia deve começar (indexado a partir de 0). O padrão é 0 , começando na primeira etapa.
• checkHistory (booleano) – Se falso, o guia ignorará se já foi exibido antes e verificará apenas as condições básicas de segmentação. Se verdadeiro, aplicará todas as condições do guia (segmentação, frequência de exibição, segmentação) como se fosse acionado normalmente. O padrão é false .

Exemplos

Acione um guia com opções padrão

 userGuiding.previewGuide(1234)

Inicie um guia a partir da segunda etapa somente quando o usuário atender às condições de segmentação e aparência.

 userGuiding.previewGuide(
	1234, {
		initialStep: 2,
 		checkHistory: true
	}
 )

Finalize o guia

Interrompe imediatamente qualquer guia que esteja sendo visualizada (ou seja, o guia ativo no momento). Isso fechará a interface do guia na página.

Definição de tipo

 type finishPreview = () => void

Exemplo

Pare qualquer guia ativo

 userGuiding.finishPreview();

Prossiga para a próxima etapa do guia.

Interrompe imediatamente qualquer guia que esteja sendo visualizada (ou seja, o guia ativo no momento). Isso fechará a interface do guia na página.

Definição de tipo

 type goToNextGuideStep = (stepIndex?: number) => void

Parâmetro opcional:

• stepIndex (número) – O número da etapa para a qual ir (indexado a partir de 0). O padrão é a etapa atual + 1.

Exemplos

Vá para a próxima etapa.

 userGuiding.goToNextGuideStep();

Vá para o 5º passo.

 userGuiding.goToNextGuideStep(4);