foo-webview-sdk
    Preparing search index...

    Interface RatingSetSuccess

    Successful response from rating.set.

    interface RatingSetSuccess {
        menuPath?: string;
        note?: string;
        path: string;
        rating: number;
        storage: "file" | "stats";
        success: true;
    }
    Index
    menuPath? note? path rating storage success
    menuPath?: string

    The context-menu path that ran; present when storage is stats.

    note?: string

    Why the tag was written instead; present when storage is file.

    path: string

    The path as given; (current) when path was omitted and foo_playcount took the rating.

    rating: number

    The rating that was set.

    storage: "file" | "stats"

    stats when foo_playcount's menu ran; file when the RATING tag write was dispatched.

    success: true

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

    Settings
    Member Visibility

    On This Page
    Properties