foo-webview-sdk
    Preparing search index...

    Interface MetadataRemoveFieldSuccess

    Successful response from metadata.removeField.

    interface MetadataRemoveFieldSuccess {
        dispatched?: boolean;
        note?: string;
        path: string;
        removedCount: number;
        removedTags: string[];
        subsong?: number;
        success: true;
    }
    Index
    dispatched? note? path removedCount removedTags subsong? success
    dispatched?: boolean

    true when the removal was dispatched; absent for an empty tags.

    note?: string

    A reminder that the outcome arrives as metadata:writeComplete; present when dispatched.

    path: string

    The path as given.

    removedCount: number

    Number of names in removedTags.

    removedTags: string[]

    The tag names queued for removal, upper-cased, in the order given.

    subsong?: number

    Subsong the removal targets; present when dispatched.

    success: true

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

    Settings
    Member Visibility

    On This Page
    Properties