Interface MediaListsVariables

MediaListsVariables is an interface representing the variables for the MediaListsQuery. It includes optional page, per page, id, user id, user name, type, status, media id, is following, notes, started at, completed at, compare with auth list, user id in, status in, status not in, status not, media id in, media id not in, notes like, started at greater, started at lesser, started at like, completed at greater, completed at lesser, completed at like, sort, score format, as array, and as html.

interface MediaListsVariables {
    asArray?: boolean;
    asHtml?: boolean;
    compareWithAuthList?: boolean;
    completedAt?: number;
    completedAt_greater?: number;
    completedAt_lesser?: number;
    completedAt_like?: string;
    id?: number;
    isFollowing?: boolean;
    mediaId?: number;
    mediaId_in?: number[];
    mediaId_not_in?: number[];
    notes?: string;
    notes_like?: string;
    page?: number;
    perPage?: number;
    scoreFormat?: string;
    sort?: string[];
    startedAt?: number;
    startedAt_greater?: number;
    startedAt_lesser?: number;
    startedAt_like?: string;
    status?: string;
    status_in?: string[];
    status_not?: string;
    status_not_in?: string[];
    type?: string;
    userId?: number;
    userId_in?: number[];
    userName?: string;
}

Properties

asArray? asHtml? compareWithAuthList? completedAt? completedAt_greater? completedAt_lesser? completedAt_like? id? isFollowing? mediaId? mediaId_in? mediaId_not_in? notes? notes_like? page? perPage? scoreFormat? sort? startedAt? startedAt_greater? startedAt_lesser? startedAt_like? status? status_in? status_not? status_not_in? type? userId? userId_in? userName?

Properties

Optional asArray

asArray?: boolean

asArray is a boolean representing whether to return the result as an array.

Optional asHtml

asHtml?: boolean

asHtml is a boolean representing whether to return the result as HTML.

Optional compareWithAuthList

compareWithAuthList?: boolean

compareWithAuthList is a boolean representing whether to compare with the authenticated list.

Optional completedAt

completedAt?: number

completedAt is a number representing the completion date of the media list.

Optional completedAt_greater

completedAt_greater?: number

completedAt_greater is a number representing the minimum completion date.

Optional completedAt_lesser

completedAt_lesser?: number

completedAt_lesser is a number representing the maximum completion date.

Optional completedAt_like

completedAt_like?: string

completedAt_like is a string representing the completion date that should be included.

Optional id

id?: number

id is a number representing the id of the media list.

Optional isFollowing

isFollowing?: boolean

isFollowing is a boolean representing whether the user is following the media.

Optional mediaId

mediaId?: number

mediaId is a number representing the id of the media.

Optional mediaId_in

mediaId_in?: number[]

mediaId_in is an array of numbers representing the media ids that should be included.

Optional mediaId_not_in

mediaId_not_in?: number[]

mediaId_not_in is an array of numbers representing the media ids that should not be included.

Optional notes

notes?: string

notes is a string representing the notes for the media list.

Optional notes_like

notes_like?: string

notes_like is a string representing the notes that should be included.

Optional page

page?: number

page is a number representing the page number.

Optional perPage

perPage?: number

perPage is a number representing the number of items per page.

Optional scoreFormat

scoreFormat?: string

scoreFormat is a string representing the score format.

Optional sort

sort?: string[]

sort is an array of strings representing the sort order.

Optional startedAt

startedAt?: number

startedAt is a number representing the start date of the media list.

Optional startedAt_greater

startedAt_greater?: number

startedAt_greater is a number representing the minimum start date.

Optional startedAt_lesser

startedAt_lesser?: number

startedAt_lesser is a number representing the maximum start date.

Optional startedAt_like

startedAt_like?: string

startedAt_like is a string representing the start date that should be included.

Optional status

status?: string

status is a string representing the status of the media list.

Optional status_in

status_in?: string[]

status_in is an array of strings representing the statuses that should be included.

Optional status_not

status_not?: string

status_not is a string representing the status that should not be included.

Optional status_not_in

status_not_in?: string[]

status_not_in is an array of strings representing the statuses that should not be included.

Optional type

type?: string

type is a string representing the type of the media.

Optional userId

userId?: number

userId is a number representing the id of the user.

Optional userId_in

userId_in?: number[]

userId_in is an array of numbers representing the user ids that should be included.

Optional userName

userName?: string

userName is a string representing the name of the user.

Settings

Member Visibility

Theme

On This Page

asArrayasHtmlcompareWithAuthListcompletedAtcompletedAt_greatercompletedAt_lessercompletedAt_likeidisFollowingmediaIdmediaId_inmediaId_not_innotesnotes_likepageperPagescoreFormatsortstartedAtstartedAt_greaterstartedAt_lesserstartedAt_likestatusstatus_instatus_notstatus_not_intypeuserIduserId_inuserName