Skip to content

Checkout

//trimblecloud-fileservice/trimblecloud.fileservice/FilesAPI/checkout

checkout

[JVM]
abstract fun checkout(@NonNullrequest: @NonNullCheckoutFileRequest): CompletableFuture<Response<File>>

Checking out a file will prevent other actors from creating a new version or other mutation operations.

Return

A future that resolves to a Response object containing the result of the checkout operation.

Parameters

JVM

request- The checkout request

Throws

TCPServiceException- If an error occurs due to API or network-related issues.
SDKClientException- If a client-side error occurs within the SDK.

[JVM]
abstract fun checkout(@NonNullrequest: @NonNullCheckoutFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<File>>

Checking out a file will prevent other actors from creating a new version or other mutation operations.

Return

A future that resolves to a Response object containing the result of the checkout operation.

Parameters

JVM

request- The checkout request
requestHeader- The request header containing additional information.

Throws

TCPServiceException- If an error occurs due to API or network-related issues.
SDKClientException- If a client-side error occurs within the SDK.