Interface UserLibraryApiGetLatestMediaRequest

Request parameters for getLatestMedia operation in UserLibraryApi.

Export

UserLibraryApiGetLatestMediaRequest

interface UserLibraryApiGetLatestMediaRequest {
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableUserData?: boolean;
    fields?: ItemFields[];
    groupItems?: boolean;
    imageTypeLimit?: number;
    includeItemTypes?: BaseItemKind[];
    isPlayed?: boolean;
    limit?: number;
    parentId?: string;
    userId?: string;
}

Properties

enableImages? enableImageTypes? enableUserData? fields? groupItems? imageTypeLimit? includeItemTypes? isPlayed? limit? parentId? userId?

Properties

Optional ReadonlyenableImages

enableImages?: boolean

Optional. include image information in output.

Memberof

UserLibraryApiGetLatestMedia

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

UserLibraryApiGetLatestMedia

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. include user data.

Memberof

UserLibraryApiGetLatestMedia

Optional Readonlyfields

fields?: ItemFields[]

Optional. Specify additional fields of information to return in the output.

Memberof

UserLibraryApiGetLatestMedia

Optional ReadonlygroupItems

groupItems?: boolean

Whether or not to group items into a parent container.

Memberof

UserLibraryApiGetLatestMedia

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

Optional. the max number of images to return, per image type.

Memberof

UserLibraryApiGetLatestMedia

Optional ReadonlyincludeItemTypes

includeItemTypes?: BaseItemKind[]

Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

Memberof

UserLibraryApiGetLatestMedia

Optional ReadonlyisPlayed

isPlayed?: boolean

Filter by items that are played, or not.

Memberof

UserLibraryApiGetLatestMedia

Optional Readonlylimit

limit?: number

Return item limit.

Memberof

UserLibraryApiGetLatestMedia

Optional ReadonlyparentId

parentId?: string

Specify this to localize the search to a specific item or folder. Omit to use the root.

Memberof

UserLibraryApiGetLatestMedia

Optional ReadonlyuserId

userId?: string

User id.

Memberof

UserLibraryApiGetLatestMedia

Settings

Member Visibility

On This Page

Properties