Interface RatingGetSuccess

Successful response from rating.get.

interface RatingGetSuccess {
    path: string;
    rating: number;
    storage: "file" | "stats";
    success: true;
}

Properties

path: string

The path as given, suffix included.

rating: number

Rating from 0 to 5; 0 means unrated.

storage: "file" | "stats"

stats for a foo_playcount rating; file for the RATING tag, and also when neither source has a rating.

success: true

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