Class ESPFile

Represents an uploaded file in the ESP RainMaker SDK.

Returned by upload confirm, list, and lookup helpers. Use refresh to fetch the latest metadata, download to fetch file bytes, and updatePublic to change visibility.

Implements

Constructors

constructor

Properties

description? downloadUrl? entityId? entityType? fileId fileMd5? fileName? fileType? metadata? public? s3Key? timestamp? userId? userName?

Methods

delete download getDownloadUrl refresh update updatePublic

Constructors

constructor

Properties

Optionaldescription

description?: string

User-provided description.

OptionaldownloadUrl

downloadUrl?: string

Presigned download URL when available.

OptionalentityId

entityId?: string

Entity id the file is associated with.

OptionalentityType

entityType?: string

Entity type the file is associated with.

fileId

fileId: string

The unique file id.

OptionalfileMd5

fileMd5?: string

Hex MD5 checksum of the file content.

OptionalfileName

fileName?: string

RainMaker-side file name.

OptionalfileType

fileType?: string

Custom file type label.

Optionalmetadata

metadata?: string | Record<string, unknown>

Optional metadata attached at confirm time.

Optionalpublic

public?: boolean

Whether the file is public.

Optionals3Key

s3Key?: string

S3 object key.

Optionaltimestamp

timestamp?: string

Upload timestamp from the backend.

OptionaluserId

userId?: string

Owner user id from the backend.

OptionaluserName

userName?: string

Owner username from the backend.

Methods

delete

  • delete(): Promise<void>

    Deletes this uploaded file from RainMaker.

    Returns Promise<void>

download

getDownloadUrl

  • getDownloadUrl(): undefined | string

    Returns the cached presigned download URL without network I/O.

    Returns undefined | string

    The download URL when known.

refresh

  • refresh(): Promise<null | ESPFile>

    Fetches the latest file metadata from the cloud and updates this instance.

    Returns Promise<null | ESPFile>

    This instance with refreshed fields, or null when no record exists.

update

updatePublic

  • updatePublic(isPublic: boolean): Promise<ESPFile>

    Sets whether this file is public.

    Parameters

    • isPublic: boolean

      true to make the file public.

    Returns Promise<ESPFile>

    This instance with refreshed fields from the backend.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods