foo-webview-sdk
    Preparing search index...

    Interface LyricsSaveSuccess

    Successful response from lyrics.save.

    interface LyricsSaveSuccess {
        dispatched?: boolean;
        handlePath?: string;
        note?: string;
        path?: string;
        results?: Record<string, JsonValue>;
        savedTo?: string;
        subsong?: number;
        success: true;
        tagsApplied?: Record<string, string>;
        tagsRemoved?: number;
        tagsSet?: number;
    }
    Index
    dispatched? handlePath? note? path? results? savedTo? subsong? success tagsApplied? tagsRemoved? tagsSet?
    dispatched?: boolean

    true when a single embedded target dispatched the tag write; the final outcome arrives as metadata:writeComplete.

    handlePath?: string

    Path of the handle the tag write targets; present for a single embedded target.

    note?: string

    A note about the dispatch; present for a single embedded target.

    path?: string

    The path as given; present for a single embedded target.

    results?: Record<string, JsonValue>

    With several targets: each target's own envelope ({ success, savedTo }, the tag write receipt, or { success: false, error, code }) under file or embedded.

    savedTo?: string

    Full path of the file written; present for a single file target.

    subsong?: number

    Subsong the tag write targets; present for a single embedded target.

    success: true

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

    tagsApplied?: Record<string, string>

    The tag written, keyed by its upper-case name; present for a single embedded target.

    tagsRemoved?: number

    Number of tags removed; present for a single embedded target.

    tagsSet?: number

    Number of tags set; present for a single embedded target.

    Settings
    Member Visibility

    On This Page
    Properties