Identificar

Define o ID do usuário e envia os atributos do usuário. Quando a identificação do usuário está habilitada, este método deve ser chamado primeiro para que o SDK UserGuiding funcione.

Definição de tipo

 type identify = (
	userId: string,
	attributes?: Object
 ) => void

Exemplo:

Identificar o usuário com base em seus atributos.

 window.userGuiding.identify('1Ax69i57j0j69i60l4', {
 email: '[email protected]',
 name: 'Awesome User',
 created_at: 1644403436643,
 })

Identificar o usuário com base em seus atributos pessoais e da empresa.

 window.userGuiding.identify('1Ax69i57j0j69i60l4', {
 name: 'Awesome User',
 company: {
   id: '1',  // *company id is required
   name: 'Awesome Company',
   created_at: 1644403436643,
 }
 })

Identificar o usuário sem atributos, apenas com o ID do usuário.

 window.userGuiding.identify('1Ax69i57j0j69i60l4')`

Evento de pista

Rastreia uma ação do usuário com uma carga útil opcional.

Definição de tipo

 type track = (
	event: string,
	payload?: Object
 ) => void

Exemplo:

Rastrear evento sem metadados

 userGuiding.track('subscription_started')

Registre o evento com metadados.

 userGuiding.track('subscription_started', {
  plan: 'enterprise',
  created_at: 1644403436643
 })

Identidade clara

Limpa as informações de identidade do UserGuiding para a sessão atual do navegador.
Isso remove os cookies de autenticação usados para a verificação da identidade do usuário e redefine o estado da identidade do usuário do SDK (por exemplo, para revogar o acesso à Base de Conhecimento ao sair).

Definição de tipo

 type clearIdentity = () => void

Exemplo

Exemplo de fluxo de logout

 async function handleLogout() {
  // 1. Invalidate your app session
  await api.post('/logout')

  // 2. Clear UserGuiding identity + KB access
  window.userGuiding.clearIdentity()

  // 3. Redirect or clean up app state
  window.location.href = '/login'
 }

Identificação de Força

Obtém os atributos mais recentes do usuário. Isso é útil quando você envia atributos por meio de uma integração no servidor e precisa que os atributos do usuário sejam atualizados instantaneamente em seu aplicativo.

Definição de tipo

 type forceIdentify = () => void