Skip to main content

API Reference

Documentação da API pública do GoAB Survey SDK React Native.


SurveySdkFactory​

Factory para criar instâncias do SDK.

create​

import type { SurveyStorage } from '@goab_ltda/survey-sdk-react-native';

function create(options: {
accountId: number;
apiToken: string;
timeoutMillis?: number;
storage?: SurveyStorage;
}): SurveySdk;
ParâmetroTipoDescrição
accountIdnumberID da conta GoAB
apiTokenstringToken de API
timeoutMillisnumberTimeout HTTP (milissegundos; padrão: 30 000)
storageSurveyStorageArmazenamento chave/valor; padrão: AsyncStorage (peer dependency)

Retorna: instância de SurveySdk (não inicializada até initialize).

Exemplo:

import { SurveySdkFactory } from '@goab_ltda/survey-sdk-react-native';

const surveySdk = SurveySdkFactory.create({
accountId: 2,
apiToken: 'your-api-token',
timeoutMillis: 30_000,
});

SurveyStorage​

Formato de armazenamento chave/valor assíncrono que o create aceita em storage. Qualquer objeto com estes três métodos serve — por exemplo, um adaptador de MMKV.

interface SurveyStorage {
getItem(key: string): Promise<string | null>;
setItem(key: string, value: string): Promise<void>;
removeItem(key: string): Promise<void>;
}

SurveyHost​

Componente React que apresenta a pesquisa na tela — equivalente ao setPresentationHost dos SDKs nativos. Monte-o uma vez, como último filho da raiz do app.

function SurveyHost(props: {
sdk: SurveySdk;
bottomInset?: number;
}): JSX.Element;
PropTipoObrigatórioDescrição
sdkSurveySdkSimA instância criada por SurveySdkFactory.create
bottomInsetnumberNãoEspaço extra abaixo da barra minimizada (ex.: a área segura inferior do aparelho)

Exemplo:

<SurveyHost sdk={surveySdk} bottomInset={insets.bottom} />

OnSurveyEventListener​

Tipo de callback para os eventos da pesquisa — impressão, resposta, minimizar, envio, fecho, etc.

type OnSurveyEventListener = (event: SurveyAnalyticsEvent) => void;

A tipagem de SurveyAnalyticsEvent, a lista de tipos de evento e exemplos de uso estão em Eventos de Survey.

Exemplo:

const listener: OnSurveyEventListener = (event) => {
console.log(`event=${event.eventType} surveyId=${event.surveyId}`);
};

surveySdk.addOnSurveyEventListener(listener);

// ao desmontar / logout:
surveySdk.removeOnSurveyEventListener(listener);

SurveySdk​

Classe principal do SDK.

initialize​

initialize(): Promise<void>

Prepara o SDK para uso. Chame uma vez depois de criar a instância.

Exemplo:

useEffect(() => {
surveySdk.initialize();
}, []);

isInitialized​

isInitialized(): boolean

Retorna: true se initialize concluiu.


sendEvent​

sendEvent(eventName: string, props?: Record<string, unknown>): void

Informa ao SDK que algo aconteceu na app (ex.: o usuário abriu uma tela ou concluiu uma ação). O SDK avalia se deve exibir uma pesquisa.

ParâmetroTipoDescrição
eventNamestringNome do evento (ex.: "screen_view", "purchase")
propsRecord<string, unknown>Propriedades do evento. Para telas: screen_name, screen_class

Comportamento:

  • Se o SDK ainda não terminou o initialize, o evento fica guardado e é enviado assim que o SDK ficar pronto (até 20 eventos, descartando o mais antigo, e só se tiverem menos de 30 segundos). Trocar o usuário com setUserId ou chamar disposeSurvey descarta os eventos guardados.
  • Ignorado se já houver uma pesquisa aberta na tela.
  • Ignorado (silenciosamente, com aviso no log) se não houver um <SurveyHost> montado quando o SDK decidir exibir uma pesquisa.

Exemplo:

surveySdk.sendEvent('screen_view', {
screen_name: 'ProductDetail',
screen_class: 'ProductDetailScreen',
});

surveySdk.sendEvent('checkout_started', { cart_value: 150.0 });

setUserId​

setUserId(userId: string | null): void

Define o ID do usuário logado.

  • null ou string em branco remove o usuário.
  • Ao mudar o ID, pesquisas abertas são fechadas e uma nova sessão analítica é iniciada.
  • Sem um usuário definido, o SDK usa um identificador anônimo próprio (gerado e guardado no aparelho) nas chamadas ao servidor; quando você define o usuário, ele passa a valer no lugar do anônimo.

setUserAttributes​

setUserAttributes(attributes: Record<string, string> | null): void

Define atributos do usuário (ex.: plano, segmento, país).

surveySdk.setUserAttributes({ plan: 'enterprise', locale: 'pt-BR' });

surveySdk.setUserAttributes(null); // limpar

disposeSurvey​

disposeSurvey(): void

Fecha qualquer pesquisa visível na tela.

Pode ser chamado mesmo antes de initialize.

surveySdk.disposeSurvey();

addOnSurveyEventListener​

addOnSurveyEventListener(listener: OnSurveyEventListener): void

Registra um observador de eventos da pesquisa.

  • Vários listeners podem coexistir.
  • O mesmo objeto função não é registrado duas vezes (comparação por referência).

removeOnSurveyEventListener​

removeOnSurveyEventListener(listener: OnSurveyEventListener): void

Remove um listener previamente registrado com addOnSurveyEventListener.


Exemplo completo​

import { useEffect } from 'react';
import { SurveySdkFactory, SurveyHost } from '@goab_ltda/survey-sdk-react-native';
import type { SurveyAnalyticsEvent } from '@goab_ltda/survey-sdk-react-native';

const surveySdk = SurveySdkFactory.create({
accountId: 2,
apiToken: 'your-api-token',
timeoutMillis: 30_000,
});

export default function App() {
useEffect(() => {
surveySdk.setUserId(getLoggedInUserId());
surveySdk.initialize();

const listener = (event: SurveyAnalyticsEvent) => {
console.log('survey event', event.eventType);
};
surveySdk.addOnSurveyEventListener(listener);
return () => surveySdk.removeOnSurveyEventListener(listener);
}, []);

return (
<>
<Navegacao />
<SurveyHost sdk={surveySdk} />
</>
);
}

function onCheckoutOpened() {
surveySdk.sendEvent('screen_view', { screen_name: 'Checkout' });
}

function onLogout() {
surveySdk.disposeSurvey();
surveySdk.setUserId(null);
surveySdk.setUserAttributes(null);
}

Próximos passos​