saltfish/dist/core/services/ShareLinkService.d.ts

An interactive video-guided tour system for web applications

export interface ShareLinkData {
    shareId: string;
    flowId: string;
    email: string;
    createdBy: string;
    website: string;
    isGlobal: boolean;
}
/**
 * ShareLinkService handles detection and processing of share links in the URL.
 * Share links allow playlists to be auto-started with highest priority, bypassing normal triggers.
 */
export declare class ShareLinkService {
    /**
     * Detects if the current URL contains a saltfish-share-id parameter
     * @returns The shareId if found, null otherwise
     */
    detectShareIdFromUrl(): string | null;
    /**
     * Fetches share data from the share API
     * @param shareId The share ID to fetch
     * @returns Share data including flowId
     * @throws Error if API call fails or returns invalid data
     */
    fetchShareData(shareId: string): Promise<ShareLinkData>;
    /**
     * Main orchestration method: detects share link and fetches flow data
     * @returns The share data to auto-start, or null if no valid share link found
     */
    shouldAutoStartSharePlaylist(): Promise<ShareLinkData | null>;
}
//# sourceMappingURL=ShareLinkService.d.ts.map