@flagship.io/react-native-sdk
Version:
Flagship SDK for React Native
24 lines (23 loc) • 963 B
TypeScript
import { UseFlagshipOutput as OriginalUseFlagshipOutput } from '@flagship.io/react-sdk';
export type UseFlagshipOutput = Omit<OriginalUseFlagshipOutput, 'collectEAIEventsAsync'> & {
/**
* Collect Emotion AI events.
* @param screenName The name of the screen to be displayed.
* @returns
*/
collectEAIEventsAsync: (screenName: string) => Promise<void>;
/**
* Send a page view event to Emotion AI service.
*
* This function should be invoked each time a new screen is displayed.
*
* We recommend calling this function in the useEffect hook of the screen component when the screen is mounted.
*
* No event will be sent when the emotion AI event collection is not in progress.
*
* @param screenName The name of the screen to be displayed.
* @returns
*/
sendEaiPageViewAsync: (screenName: string) => Promise<void>;
};
export declare const useFlagship: () => UseFlagshipOutput;