kotlin-odata/com.sap.cloud.mobile.kotlin.odata/RequestOptions

RequestOptions

Options for processing of data requests. If request options are used for {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#repeatable(com.sap.cloud.mobile.kotlin.odata.GuidValue, com.sap.cloud.mobile.kotlin.odata.GlobalDateTime) RequestOptions.repeatable} requests, a new request options object should be used for each distinct request (or the repeatability properties should be reset before object re-use). The repeated execution of a failed request should re-use the original request options object without {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#repeatable(com.sap.cloud.mobile.kotlin.odata.GuidValue, com.sap.cloud.mobile.kotlin.odata.GlobalDateTime) RequestOptions.repeatable} being reset beforehand.

Constructors

RequestOptions

constructor()

Types

Companion

object Companion

Properties

backgroundFile

open var backgroundFile: String?

backgroundName

open var backgroundName: String?

cancelToken

open var cancelToken: CancelToken?

canCombineRequests

open var canCombineRequests: Boolean

captureResponseHeaders

open var captureResponseHeaders: Any?

changeSet

open var changeSet: String?

customTag

open var customTag: String?

joinChangeSet

open var joinChangeSet: EntityValue?

mustRetainCreates

open var mustRetainCreates: Boolean

preferNoContent

open var preferNoContent: Boolean

repeatabilityFirstSent

open var repeatabilityFirstSent: GlobalDateTime?

repeatabilityRequestID

open var repeatabilityRequestID: GuidValue?

sendEmptyUpdate

open var sendEmptyUpdate: Boolean

updateMode

open var updateMode: UpdateMode

uploadGroup

open var uploadGroup: String?

useBatchRequest

open var useBatchRequest: Boolean

Functions

cancelable

open fun cancelable(): RequestOptions

See cancelable(CancelToken).

open fun cancelable(token: CancelToken): RequestOptions

Set the {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#cancelToken RequestOptions.cancelToken} and return this options object.

copy

open fun copy(): RequestOptions

Return a new (mutable) request options object that is a copy of this request options object.

custom

open fun custom(tag: String): RequestOptions

Set the {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#customTag RequestOptions.customTag} and return this options object.

joinTransaction

open fun joinTransaction(entity: EntityValue): RequestOptions

Set the {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#joinChangeSet RequestOptions.joinChangeSet} to the provided 'entity' and return this options object. The provided entity should elsewhere be specified for a createEntity / updateEntity / deleteEntity as the first request within a change set.

noCombine

open fun noCombine(): RequestOptions

Set the {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#canCombineRequests RequestOptions.canCombineRequests} property to false and return this options object.

noRetain

open fun noRetain(): RequestOptions

Set the {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#mustRetainCreates RequestOptions.mustRetainCreates} property to false and return this options object.

repeatable

open fun repeatable(requestID: GuidValue, firstSent: GlobalDateTime): RequestOptions

Set the {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#repeatabilityRequestID RequestOptions.repeatabilityRequestID} and {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#repeatabilityFirstSent RequestOptions.repeatabilityFirstSent} and return this options object.

transaction

open fun transaction(id: String): RequestOptions

Set the {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#changeSet RequestOptions.changeSet} and return this options object.

update

open fun update(mode: UpdateMode): RequestOptions

Set the {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#updateMode RequestOptions.updateMode} and return this options object.

uploadInGroup

open fun uploadInGroup(group: String): RequestOptions

Set the {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#uploadGroup RequestOptions.uploadGroup} and return this options object.

useBatch

open fun useBatch(): RequestOptions

Set {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#useBatchRequest RequestOptions.useBatchRequest} to true and this options object.