@withjoy/sdk-js/lib/telemetry/ITelemetry.d.ts

Joy Javascript SDK

export interface ITelemetry {
    clone(): ITelemetry;
    context(): any;
    setEvent(eventId: string): any;
    clearEvent(): any;
    trace(any: any): any;
    debug(any: any): any;
    info(any: any): any;
    warn(any: any): any;
    error(any: any): any;
    identify(userId: string, profile: any): any;
    /**
     * Logs a user event with telemetry
     * @param category -- e.g "Admin" "Joy" or "Wedding"
     * @param action -- e.g. "ColorSet"
     * @param label -- e.g. "#121212"
     * @param route -- e.g. "/joe-and-jane"
     * @param referrer -- e.g. "/"
     * @param extraInfo -- anything
     */
    event(category: {
        category: string;
        action: string;
        label?: any;
        route?: string;
        referrer?: string;
        extraInfo?: any;
    } | string, action?: string, route?: string, referrer?: string, extraInfo?: any): any;
    /**
     * Logs a page view with telemetry
     * @param category -- e.g "Admin" "Joy" or "Wedding"
     * @param name -- e.g. "Joe & Jane"
     * @param route -- e.g. "/joe-and-jane"
     * @param referrer -- e.g. "/"
     * @param extraInfo -- anything
     */
    page(category: string, name: string, route: string, referrer: string, extraInfo: any): any;
    /**
     * Logs a user event with telemetry
     * @param linkElementId
     * @param category -- e.g "Admin" "Joy" or "Wedding"
     * @param action -- e.g. "ColorSet"
     * @param label -- e.g. "#121212"
     * @param route -- e.g. "/joe-and-jane"
     * @param referrer -- e.g. "/"
     * @param extraInfo -- anything
     */
    link(linkElementId: string, category: string, action: string, route: string, referrer: string, extraInfo: string): any;
    /**
     * Makes sure that all telemetry has been recorded. Best called before crash or when script unload is imminent.
     * @param callback
     */
    flush(callback: () => void): any;
}