Skip to content
Last updated

PERS SDK - v2.3.26 / Exports / FileApi

Class: FileApi

Platform-Agnostic File API Client

Handles file operations using the PERS backend's RESTful endpoints.

Table of contents

Constructors

Methods

Constructors

constructor

new FileApi(apiClient): FileApi

Parameters

NameType
apiClientPersApiClient

Returns

FileApi

Defined in

file/api/file-api.ts:15

Methods

getSignedUrl

getSignedUrl(request): Promise<SignedUrlResponse>

PUBLIC: Get signed URL for file operations

Parameters

NameTypeDescription
requestSignedUrlRequestSigned URL request parameters

Returns

Promise<SignedUrlResponse>

Promise resolving to signed URL response

Defined in

file/api/file-api.ts:29


getSignedGetUrl

getSignedGetUrl(url, expireSeconds?): Promise<SignedUrlResponse>

PUBLIC: Get signed GET URL for file access

Parameters

NameTypeDescription
urlstringFile URL
expireSeconds?numberOptional expiration time in seconds

Returns

Promise<SignedUrlResponse>

Promise resolving to signed URL response

Defined in

file/api/file-api.ts:40


optimizeMediaFromUrl

optimizeMediaFromUrl(request): Promise<FileOptimizeResponse>

PUBLIC: Optimize media from URL

Parameters

NameTypeDescription
requestFileOptimizeRequestFile optimization request

Returns

Promise<FileOptimizeResponse>

Promise resolving to optimized file URL

Defined in

file/api/file-api.ts:55