Conselhos e respostas da equipe UserGuiding
Usuários
Engajamento
Configurações
Casos de Uso e Boas Práticas
Central de Recursos
Aprenda a utilizar os métodos da Central de Recursos da API JavaScript do UserGuiding.

💡 Você pode acessar https://developers.userguiding.com/ para consultar informações mais atualizadas sobre esse tópico e a documentação para desenvolvedores.


Acionamento da Central de Recursos

Abra um Centro de Recursos pelo seu ID. Se outro Centro de Recursos estiver ativo, ele será fechado e o solicitado será aberto.


Definição de tipo

 type launchResourceCenter = (
resourceCenterId: number,
options?: {
bypassFilters?: boolean,
sidebarOpen?: boolean,
tab?: 'home' | 'knowledgeBase' | 'aiAssistant' | 'productUpdates',
articleId?: string,
checklistId?: number
}
) => void


Parâmetros opcionais:

  • bypassFilters (booleano) – Se verdadeiro, inicia a Central de Recursos sem verificar nenhuma regra de segmentação ou direcionamento. Se for falso, todas as condições de direcionamento de página, segmentação de público e agendamento para essa Central de Recursos serão verificadas primeiro. O padrão é verdadeiro .
  • sidebarOpen (booleano) – Se verdadeiro, a Central de Recursos será iniciada expandida. O padrão é falso .
  • tab (string) - Substitui a guia de abertura padrão da central de recursos. As opções são:
    • home
    • knowledgeBase
    • aiAssistant
    • productUpdates
  • articleId (string) - Selecione um artigo para a base de conhecimento exibir. Deve ser usado em conjunto com o parâmetro tab definido como knowledgeBase .
  • checklistId (número) - Cria um link direto para um módulo de lista de verificação específico dentro da Central de Recursos. O ID deve corresponder a um módulo de lista de verificação configurado na Central de Recursos de destino; caso contrário, a Central de Recursos será aberta normalmente na guia inicial e um aviso [UserGuiding] será registrado. Força a abertura da guia home quando usado.

Exemplos

Dispare uma Central de Recursos com opções padrão.


 userGuiding.launchResourceCenter(1234)


Acione um Centro de Recursos e expanda-o mesmo que as regras não correspondam.


 userGuiding.launchResourceCenter(1234, {
sidebarOpen: true,
bypassFilters: true
})


Dispare um Centro de Recursos somente se as regras forem atendidas. Ele pode ser expandido ou recolhido.


 userGuiding.launchResourceCenter(1234, {
bypassFilters: false,
sidebarOpen: true
})


Abra um artigo da base de conhecimento dentro da Central de Recursos.


 userGuiding.launchResourceCenter(1234, {
tab: 'knowledgeBase',
sidebarOpen: true,
articleId: '123',
})


Abra um módulo específico da lista de verificação dentro da Central de Recursos.


 userGuiding.launchResourceCenter(1234, {
checklistId: 5678,
sidebarOpen: true,
})


Abra a aba de atualizações de produtos dentro da Central de Recursos.


 userGuiding.launchResourceCenter(10, {
tab: 'productUpdates',
sidebarOpen: true,
})


Expandir Centro de Recursos

Expande a área de conteúdo de um Centro de Recursos ativo.


Definição de tipo

 type expandResourceCenter = () => void


Exemplo

Expande a central de recursos se ela estiver minimizada.


 userGuiding.expandResourceCenter();


Recolher Central de Recursos

Recolhe um widget aberto da Central de Recursos. Isso ocultará a área de conteúdo e exibirá apenas o iniciador da Central de Recursos.


Definição de tipo

 type collapseResourceCenter = () => void


Exemplo

Desativa o centro de recursos se ele estiver aberto.


 userGuiding.collapseResourceCenter();


Ocultar Central de Recursos

Fecha o widget do Centro de Recursos atualmente ativo, removendo-o da página.


Definição de tipo

 type hideResourceCenter = () => void


Exemplo

Oculta o centro de recursos ativo


 userGuiding.hideResourceCenter();


Isso respondeu à sua pergunta?
Ask AI
Responses are generated using AI and may contain mistakes.
How can I help you?
Ask me anything about our product. I can help you find answers across the knowledge base.
Ask a question...Ctrl+I