jellyfin-model/org.jellyfin.sdk.model.api.request/GetRemoteImagesRequest

GetRemoteImagesRequest

@Serializable

data class GetRemoteImagesRequest(val itemId: UUID, val type: ImageType? = null, val startIndex: Int? = null, val limit: Int? = null, val providerName: String? = null, val includeAllLanguages: Boolean? = false)

Available remote images for an item.

Constructors

GetRemoteImagesRequest

constructor(itemId: UUID, type: ImageType? = null, startIndex: Int? = null, limit: Int? = null, providerName: String? = null, includeAllLanguages: Boolean? = false)

Properties

includeAllLanguages

@SerialName(value = "includeAllLanguages")

val includeAllLanguages: Boolean?

Optional. Include all languages.

@SerialName(value = "itemId")

val itemId: UUID

Item Id.

@SerialName(value = "limit")

val limit: Int?

Optional. The maximum number of records to return.

@SerialName(value = "providerName")

val providerName: String?

Optional. The image provider to use.

@SerialName(value = "startIndex")

val startIndex: Int?

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

@SerialName(value = "type")

val type: ImageType?

The image type.