Interface PlaylistsApiGetPlaylistItemsRequest

Request parameters for getPlaylistItems operation in PlaylistsApi.

Export

PlaylistsApiGetPlaylistItemsRequest

interface PlaylistsApiGetPlaylistItemsRequest {
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableUserData?: boolean;
    fields?: ItemFields[];
    imageTypeLimit?: number;
    limit?: number;
    playlistId: string;
    startIndex?: number;
    userId?: string;
}

Properties

enableImages? enableImageTypes? enableUserData? fields? imageTypeLimit? limit? playlistId startIndex? userId?

Properties

Optional ReadonlyenableImages

enableImages?: boolean

Optional. Include image information in output.

Memberof

PlaylistsApiGetPlaylistItems

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

PlaylistsApiGetPlaylistItems

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. Include user data.

Memberof

PlaylistsApiGetPlaylistItems

Optional Readonlyfields

fields?: ItemFields[]

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

Memberof

PlaylistsApiGetPlaylistItems

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

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

Memberof

PlaylistsApiGetPlaylistItems

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

PlaylistsApiGetPlaylistItems

ReadonlyplaylistId

playlistId: string

The playlist id.

Memberof

PlaylistsApiGetPlaylistItems

Optional ReadonlystartIndex

startIndex?: number

Optional. The record index to start at. All items with a lower index will be dropped from the results.

Memberof

PlaylistsApiGetPlaylistItems

Optional ReadonlyuserId

userId?: string

User id.

Memberof

PlaylistsApiGetPlaylistItems

Settings

Member Visibility

On This Page

Properties