Sporades SDK API
    Preparing search index...

    Type Alias PrivilegedFileApi

    type PrivilegedFileApi = {
        createPublicUrl(
            fileReference: string,
            options?: {
                expires?: string | Date;
                noExpiry?: boolean;
                ttlSeconds?: number;
            },
        ): Promise<PrivilegedResult<{ publicUrl: PrivilegedPublicFileUrl }>>;
        delete(
            fileReference: string,
        ): Promise<PrivilegedResult<PrivilegedFileMetadata>>;
        url(
            fileReference: string,
        ): Promise<
            PrivilegedResult<{ file: PrivilegedOwnedFileMetadata; url: string }>,
        >;
    }
    Index
    createPublicUrl delete url

    • Create a public URL for one live Capsule File while preserving File runtime boundaries.

      Parameters

      • fileReference: string
      • Optionaloptions: { expires?: string | Date; noExpiry?: boolean; ttlSeconds?: number }

      Returns Promise<PrivilegedResult<{ publicUrl: PrivilegedPublicFileUrl }>>

    Settings
    Member Visibility

    On This Page
    Methods