Interface PitcherEventMap

interface PitcherEventMap {
    analytics_captured: {
        payload: any;
        type:
            | "File Entered"
            | "File Exited"
            | "Web File Entered"
            | "Web File Exited"
            | "Page Entered"
            | "Page Exited"
            | "Page Viewed"
            | "App Entered"
            | "App Exited"
            | "Canvas Entered"
            | "Canvas Exited"
            | "Canvas Shared"
            | "Customer Sentiment Captured"
            | "Canvas Page Entered"
            | "Canvas Page Exited"
            | "Canvas Component Entered"
            | "Canvas Component Exited"
            | "Canvas File Downloaded"
            | "Canvas Downloaded"
            | "User Feedback Captured"
            | "User Bug Reported"
            | "User File Reviewed"
            | "Hotspot Clicked"
            | "Collection Player Content Changed"
            | "Comment Added"
            | "Comment Replied"
            | "Comment Assigned"
            | "Comment Resolved"
            | "Comment Deleted";
    };
    canvas_updated: Record<string, any>;
    canvas_updated_success: Partial<CanvasRetrieve>;
    content_list_refresh_requested: void;
    create_and_open_canvas: CreateAndOpenCanvasEvent;
    entered_fullscreen: void;
    env_changed: PitcherEnv;
    exited_fullscreen: void;
    "favorites:changed": { body: PaginatedData<Favorite> };
    file_closed: { file_id?: string; view_id?: string };
    file_downloaded: File;
    file_opened: { file_id?: string; view_id?: string };
    file_upload_progress: { progress: number; upload_uid: string };
    "file:download": { body: string };
    network_connection_established: void;
    network_connection_lost: void;
    non_files_sync_finished: { user_triggered: boolean };
    open_canvas: OpenCanvasPitcherEvent;
    photos_captured: void;
    start_call: StartCallPitcherEvent;
    submit_postcall_clicked: void;
    "ui:hide-modal": void;
    "ui:show-modal": void;
    update_location: UpdateLocationPitcherEvent;
}

Properties

analytics_captured: {
    payload: any;
    type:
        | "File Entered"
        | "File Exited"
        | "Web File Entered"
        | "Web File Exited"
        | "Page Entered"
        | "Page Exited"
        | "Page Viewed"
        | "App Entered"
        | "App Exited"
        | "Canvas Entered"
        | "Canvas Exited"
        | "Canvas Shared"
        | "Customer Sentiment Captured"
        | "Canvas Page Entered"
        | "Canvas Page Exited"
        | "Canvas Component Entered"
        | "Canvas Component Exited"
        | "Canvas File Downloaded"
        | "Canvas Downloaded"
        | "User Feedback Captured"
        | "User Bug Reported"
        | "User File Reviewed"
        | "Hotspot Clicked"
        | "Collection Player Content Changed"
        | "Comment Added"
        | "Comment Replied"
        | "Comment Assigned"
        | "Comment Resolved"
        | "Comment Deleted";
}

iOS-only

canvas_updated: Record<string, any>
canvas_updated_success: Partial<CanvasRetrieve>
content_list_refresh_requested: void

iOS-only

create_and_open_canvas: CreateAndOpenCanvasEvent
entered_fullscreen: void

WEB-only

env_changed: PitcherEnv
exited_fullscreen: void

WEB-only

"favorites:changed": { body: PaginatedData<Favorite> }
file_closed: { file_id?: string; view_id?: string }
file_downloaded: File

iOS-only

file_opened: { file_id?: string; view_id?: string }
file_upload_progress: { progress: number; upload_uid: string }

iOS-only

"file:download": { body: string }
network_connection_established: void

iOS-only

network_connection_lost: void

iOS-only

non_files_sync_finished: { user_triggered: boolean }

iOS-only

photos_captured: void

iOS-only

submit_postcall_clicked: void
"ui:hide-modal": void
"ui:show-modal": void