ScanClient

class ScanClient(client: ApiClient)

Constructors

Link copied to clipboard
constructor(client: ApiClient)

Functions

Link copied to clipboard
suspend fun assetUrl(id: String, option: AssetUrlOption): Result<String>

This generates a time-limited URLs for a single scan capture asset, indicated by the type.

Link copied to clipboard
suspend fun assetUrls(id: String): Result<AssetUrls>

This generates time-limited URLs for scan capture assets. These include a body model (a 3D avatar in PLY format), indicators of measurement locations ("stripes", also models in PLY format), and a preview image of the body model/avatar.

Link copied to clipboard
suspend fun createScan(newScan: NewScan): Result<Scan>

This function registers a new scan in the api. This should be called before uploading any capture data. It is recommended to do this AFTER scan images are successfully captured so that any failed captures will not result in unfinished scans.

Link copied to clipboard
suspend fun deleteScan(id: String): Result<Scan>

This function deletes a single scan. NOTE: It is a hard delete, and associated data (e.g. avatars) are also deleted.

Link copied to clipboard
Link copied to clipboard
suspend fun getScan(id: String): Result<Scan>

This function fetches a single scan.

Link copied to clipboard
suspend fun getScans(token: String, limit: Int = 25, cursor: String? = null, order: SortOrder = SortOrder.DESCENDING): Result<Paginated<Scan>>

This function fetches a list of scans.

Link copied to clipboard

Fetches the body circumference measurements for a scan. The measurements are in meters.

Link copied to clipboard
suspend fun uploadUrl(id: String): Result<UploadUrl>

This generates a time-limited upload URL for scan capture data.