Thankly SDK for JavaScript
    Preparing search index...

    Interface VirtualTryOnPersistedState

    Persisted state (subset that survives page reload)

    interface VirtualTryOnPersistedState {
        error:
            | {
                message: string;
                retryable: boolean;
                type: "unknown"
                | "network"
                | "timeout"
                | "upload"
                | "generation";
            }
            | null;
        generatedImageResourceId: string
        | null;
        photoKey: string | null;
        resultImageUrl: string | null;
        resultVideoUrl: string | null;
        screen: VirtualTryOnScreen;
        selectedProductIds: string[];
    }
    Index
    error generatedImageResourceId photoKey resultImageUrl resultVideoUrl screen selectedProductIds
    error:
        | {
            message: string;
            retryable: boolean;
            type: "unknown"
            | "network"
            | "timeout"
            | "upload"
            | "generation";
        }
        | null

    Human-readable reason for the rejection.

    Type Declaration

    • {
          message: string;
          retryable: boolean;
          type: "unknown" | "network" | "timeout" | "upload" | "generation";
      }
      • message: string

        Human-readable error message.

      • retryable: boolean

        Whether retrying may succeed.

      • type: "unknown" | "network" | "timeout" | "upload" | "generation"

        Capability type for validation

    • null
    generatedImageResourceId: string | null

    Resource id of the generated image, used to request a video from it.

    photoKey: string | null

    Storage key of the uploaded photo.

    resultImageUrl: string | null

    Generated try-on image.

    resultVideoUrl: string | null

    Generated try-on video.

    screen: VirtualTryOnScreen

    Screen currently shown.

    selectedProductIds: string[]

    Catalog product IDs to try on (optional if wardrobe items provided)

    Settings
    Member Visibility

    On This Page
    Properties