Interface MediaListCollectionResponse

MediaListCollectionResponse is an interface representing the response from a media list collection query. It includes the media list collection, lists, entries, user, and hasNextChunk status.

interface MediaListCollectionResponse {
    MediaListCollection: {
        hasNextChunk: boolean;
        lists: {
            entries: {
                advancedScores: number[];
                completedAt: FuzzyDate;
                createdAt: number;
                customLists: boolean[];
                hiddenFromStatusLists: boolean;
                id: number;
                media: Media;
                mediaId: number;
                notes: string;
                priority: number;
                private: boolean;
                progress: number;
                progressVolumes: number;
                repeat: number;
                score: number;
                startedAt: FuzzyDate;
                status: string;
                updatedAt: number;
                userId: number;
            }[];
            isCustomList: boolean;
            isSplitCompletedList: boolean;
            name: string;
            status: string;
        }[];
        user: UserResponse;
    };
}

Properties

MediaListCollection

Properties

MediaListCollection

MediaListCollection: {
    hasNextChunk: boolean;
    lists: {
        entries: {
            advancedScores: number[];
            completedAt: FuzzyDate;
            createdAt: number;
            customLists: boolean[];
            hiddenFromStatusLists: boolean;
            id: number;
            media: Media;
            mediaId: number;
            notes: string;
            priority: number;
            private: boolean;
            progress: number;
            progressVolumes: number;
            repeat: number;
            score: number;
            startedAt: FuzzyDate;
            status: string;
            updatedAt: number;
            userId: number;
        }[];
        isCustomList: boolean;
        isSplitCompletedList: boolean;
        name: string;
        status: string;
    }[];
    user: UserResponse;
}

MediaListCollection is an object that includes the lists, user, and hasNextChunk status.

Type declaration

  • hasNextChunk: boolean

    hasNextChunk is a boolean representing whether there is a next chunk in the media list collection.

  • lists: {
        entries: {
            advancedScores: number[];
            completedAt: FuzzyDate;
            createdAt: number;
            customLists: boolean[];
            hiddenFromStatusLists: boolean;
            id: number;
            media: Media;
            mediaId: number;
            notes: string;
            priority: number;
            private: boolean;
            progress: number;
            progressVolumes: number;
            repeat: number;
            score: number;
            startedAt: FuzzyDate;
            status: string;
            updatedAt: number;
            userId: number;
        }[];
        isCustomList: boolean;
        isSplitCompletedList: boolean;
        name: string;
        status: string;
    }[]

    lists is an array of objects, each representing a list with entries, name, isCustomList, isSplitCompletedList, and status.

  • user: UserResponse

    user is an instance of UserResponse representing the user associated with the media list collection.

Settings

Member Visibility

Theme

On This Page

MediaListCollection