Interface RemoteImageApiGetRemoteImagesRequest

Request parameters for getRemoteImages operation in RemoteImageApi.

Export

RemoteImageApiGetRemoteImagesRequest

interface RemoteImageApiGetRemoteImagesRequest {
    includeAllLanguages?: boolean;
    itemId: string;
    limit?: number;
    providerName?: string;
    startIndex?: number;
    type?: ImageType;
}

Properties

includeAllLanguages? itemId limit? providerName? startIndex? type?

Properties

Optional ReadonlyincludeAllLanguages

includeAllLanguages?: boolean

Optional. Include all languages.

Memberof

RemoteImageApiGetRemoteImages

ReadonlyitemId

itemId: string

Item Id.

Memberof

RemoteImageApiGetRemoteImages

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

RemoteImageApiGetRemoteImages

Optional ReadonlyproviderName

providerName?: string

Optional. The image provider to use.

Memberof

RemoteImageApiGetRemoteImages

Optional ReadonlystartIndex

startIndex?: number

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

Memberof

RemoteImageApiGetRemoteImages

Optional Readonlytype

type?: ImageType

The image type.

Memberof

RemoteImageApiGetRemoteImages

Settings

Member Visibility

On This Page

Properties