foo-webview-sdk
    Preparing search index...

    Interface PlaylistGetAutoplaylistInfoSuccess

    Successful response from playlist.getAutoplaylistInfo.

    interface PlaylistGetAutoplaylistInfoSuccess {
        configAvailability: "available" | "unavailable";
        configAvailabilityReason:
            | "supported"
            | "unverifiedLock"
            | "notAutoplaylist"
            | "externalProvider";
        editorAvailability: "unknown"
        | "available"
        | "unavailable";
        editorAvailabilityReason:
            | "supported"
            | "noEditor"
            | "legacyClient"
            | "unverifiedLock"
            | "notAutoplaylist";
        isAutoplaylist: boolean;
        keepSorted?: boolean;
        lockName?: string;
        playlist: number;
        playlistGuid: string;
        source?: "sdk"
        | "dui";
        success: true;
    }
    Index
    configAvailability configAvailabilityReason editorAvailability editorAvailabilityReason isAutoplaylist keepSorted? lockName? playlist playlistGuid source? success
    configAvailability: "available" | "unavailable"

    Whether this component can read and edit the provider's configuration.

    configAvailabilityReason:
        | "supported"
        | "unverifiedLock"
        | "notAutoplaylist"
        | "externalProvider"

    Own providers are supported; external providers and unverified locks have no configuration protocol here.

    editorAvailability: "unknown" | "available" | "unavailable"

    available means the provider declares UI support; unknown means it cannot be probed without attempting the native call. Neither guarantees that a particular call shows a window.

    editorAvailabilityReason:
        | "supported"
        | "noEditor"
        | "legacyClient"
        | "unverifiedLock"
        | "notAutoplaylist"

    Why the capability is available, unavailable, or unknown. A legacy client or a compatible automatic-playlist lock has no side-effect-free editor probe.

    isAutoplaylist: boolean

    Whether the playlist is an autoplaylist. keepSorted, source and lockName are present only when it is; editor availability is always reported on success.

    keepSorted?: boolean

    Whether the manager-backed autoplaylist keeps its tracks sorted. For source: 'dui', the existing false value is a placeholder because the lock's configuration is not readable.

    lockName?: string

    Name of the playlist's lock, present when source is dui.

    playlist: number

    Index of the playlist.

    playlistGuid: string

    Unique identifier of the playlist, formatted as {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}. Pass as playlistGuid to reliably target this playlist.

    source?: "sdk" | "dui"

    sdk identifies the autoplaylist-manager path, including third-party clients; dui identifies the existing automatic-lock name heuristic. Neither identifies the current UI or editor support.

    success: true

    Always true here; a failed call resolves with ApiFailure instead.

    Settings
    Member Visibility

    On This Page
    Properties