Interface InstantMixApiGetInstantMixFromAlbumRequest

Request parameters for getInstantMixFromAlbum operation in InstantMixApi.

Export

InstantMixApiGetInstantMixFromAlbumRequest

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

Properties

enableImages? enableImageTypes? enableUserData? fields? imageTypeLimit? itemId limit? userId?

Properties

Optional ReadonlyenableImages

enableImages?: boolean

Optional. Include image information in output.

Memberof

InstantMixApiGetInstantMixFromAlbum

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

InstantMixApiGetInstantMixFromAlbum

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. Include user data.

Memberof

InstantMixApiGetInstantMixFromAlbum

Optional Readonlyfields

fields?: ItemFields[]

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

Memberof

InstantMixApiGetInstantMixFromAlbum

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

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

Memberof

InstantMixApiGetInstantMixFromAlbum

ReadonlyitemId

itemId: string

The item id.

Memberof

InstantMixApiGetInstantMixFromAlbum

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

InstantMixApiGetInstantMixFromAlbum

Optional ReadonlyuserId

userId?: string

Optional. Filter by user id, and attach user data.

Memberof

InstantMixApiGetInstantMixFromAlbum

Settings

Member Visibility

On This Page

Properties