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

PendingRequest

Represents a pending request from client to server, retained on the client during offline operation until it can be successfully uploaded to the server, or cancelled by the application.

Constructors

PendingRequest

constructor()

Types

Companion

object Companion

Properties

changeSet

open val changeSet: String?

customTag

open val customTag: String?

dataType

open override val dataType: DataType

entitySet

open val entitySet: EntitySet?

entityType

open val entityType: EntityType?

firstSent

open val firstSent: GlobalDateTime?

hasError

open val hasError: Boolean

httpHeaders

open val httpHeaders: HttpHeaders

httpMethod

open val httpMethod: String

httpStatus

open val httpStatus: Int?

lastSent

open val lastSent: GlobalDateTime?

method

open val method: RequestMethod

requestID

open val requestID: Long

requestType

open val requestType: String?

requestURL

open val requestURL: String

responseType

open val responseType: String?

status

open val status: RequestStatus

uploadGroup

open val uploadGroup: String?

Functions

cancel

open fun cancel()

Cancel this pending request any any other pending requests that depend on it.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.OfflineDataService#cancelPendingRequests(com.sap.cloud.mobile.kotlin.odata.PendingRequestList?) OfflineDataService.cancelPendingRequests}.

getAffectedEntity

open fun getAffectedEntity(): EntityValue?

See getAffectedEntity(Boolean).

open fun getAffectedEntity(fixRequest: Boolean): EntityValue?

Return (nullable) The latest client-side state of the entity (if any) that was affected by this request, or if fixRequest is true, then an entity that can be updated to directly fix this pending request.

getDependentRequests

open fun getDependentRequests(): PendingRequestList

Return the other requests (if any) that depend on the successful completion of this request.

getErrorResponse

open fun getErrorResponse(): ErrorResponse?

Return (nullable) The error response information, if {@link com.sap.cloud.mobile.kotlin.odata.PendingRequest#hasError PendingRequest.hasError} is true.

getLatestDownload

open fun getLatestDownload(): EntityValue?

See getLatestDownload(Boolean).

open fun getLatestDownload(fixRequest: Boolean): EntityValue?

Return (nullable) The latest downloaded state of the entity (if any), that was affected by this request.

getOriginalEntity

open fun getOriginalEntity(): EntityValue?

See getOriginalEntity(Boolean).

open fun getOriginalEntity(fixRequest: Boolean): EntityValue?

Return (nullable) The original downloaded state of the entity (if any), that was affected by this request.

getRequestData

open fun getRequestData(): ByteArray?

Return (nullable) HTTP request body (as binary data) if available, otherwise null.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.PendingRequest#getRequestText() PendingRequest.getRequestText}.

getRequestText

open fun getRequestText(): String?

Return (nullable) HTTP request body (as text string) if available, otherwise null. If non-null, the returned value will typically be a JSON text string. Note: If {@link com.sap.cloud.mobile.kotlin.odata.PendingRequest#method PendingRequest.method} is createMedia, uploadMedia or uploadStream, then null will be returned even if the stream's media type indicates text.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.PendingRequest#getRequestData() PendingRequest.getRequestData}.

getResponseData

open fun getResponseData(): ByteArray?

Return (nullable) HTTP response body (as binary data) if available, otherwise null.

getResponseText

open fun getResponseText(): String?

Return (nullable) HTTP response body (as text string) if available, otherwise null. If non-null, the returned value will typically be a JSON text string.

toString

open override fun toString(): String

Return string representation of this pending request, omitting request headers and content.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.PendingRequest#toStringWithDetails(kotlin.Boolean, kotlin.Boolean, kotlin.Boolean, kotlin.Boolean) PendingRequest.toStringWithDetails}.

toStringWithDetails

open fun toStringWithDetails(fetchDetails: Boolean): String

open fun toStringWithDetails(fetchDetails: Boolean, includeHeaders: Boolean): String

open fun toStringWithDetails(fetchDetails: Boolean, includeHeaders: Boolean, includeContent: Boolean): String

See toStringWithDetails(Boolean, Boolean, Boolean, Boolean).

open fun toStringWithDetails(fetchDetails: Boolean, includeHeaders: Boolean, includeContent: Boolean, hideCredentials: Boolean): String

Return string representation of this pending request, with optional details.