foo-webview-sdk
    Preparing search index...

    Interface MetadataWriteSuccess

    Successful response from metadata.write.

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

    true when the write was dispatched; absent when there was nothing to write.

    handlePath?: string

    Path of the handle the write targets, as foobar2000 stores it; present when dispatched.

    note: string

    No tags to update when nothing was left to write; otherwise a reminder that the outcome arrives as metadata:writeComplete.

    path: string

    The path as given.

    subsong?: number

    Subsong the write targets; present when dispatched.

    success: true

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

    tagsApplied?: Record<string, JsonValue>

    Every tag queued, keyed by its upper-case name: the string, number or non-empty string array given for a write, null for a removal (including an empty array). Present when dispatched.

    tagsRemoved?: number

    Number of tag fields removed, including those given as empty arrays; present when dispatched.

    tagsSet?: number

    Number of tag fields set, not the number of values; present when dispatched.

    Settings
    Member Visibility

    On This Page
    Properties