kotlin-odata/com.sap.cloud.mobile.kotlin.odata/RequestBatch/downloadStream

downloadStream

open fun downloadStream(entity: EntityValue, link: StreamLink): DataQuery

See downloadStream(EntityValue, StreamLink, HttpHeaders?, RequestOptions?).

Return

(see linked method).

Parameters

entity

Entity parameter.

link

Link parameter.

open fun downloadStream(entity: EntityValue, link: StreamLink, headers: HttpHeaders?): DataQuery

See downloadStream(EntityValue, StreamLink, HttpHeaders?, RequestOptions?).

Return

(see linked method).

Parameters

entity

Entity parameter.

link

Link parameter.

headers

Headers parameter.

open fun downloadStream(entity: EntityValue, link: StreamLink, headers: HttpHeaders?, options: RequestOptions?): DataQuery

Add a "download stream" query to the batch, to obtain a stream for downloading the content of a stream property from the target system. Caution: streams are often used for large content that may not fit (all at once) in available application memory. Having too many threads simultaneously downloading streams, or using {@link com.sap.cloud.mobile.kotlin.odata.ByteStream#readAndClose() ByteStream.readAndClose}, may result in out-of-memory conditions on memory-constrained devices.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.QueryResult#getByteStream() QueryResult.getByteStream}, {@link com.sap.cloud.mobile.kotlin.odata.QueryResult#getCharStream() QueryResult.getCharStream}.

Return

A data query representing the stream download request.

Parameters

entity

Entity containing the stream property whose content is to be downloaded.

link

Stream link for the stream to be downloaded.

headers

(nullable) Request-specific headers.

options

(nullable) Request-specific options.