Interface AttachmentService

AttachmentService

interface AttachmentService {
    createAttachment(attachment): Promise<{
        id: string;
    }>;
    deleteAttachment(attachmentId): Promise<boolean>;
    generateUploadSignedUrl(filename, contentType, contentLength): Promise<string>;
    getBucket(): Bucket;
    getDb(): Db;
    getOneAttachment(attachmentId, ownerType?, ownerId?): Promise<null | AttachmentEntity>;
    getPaginatedAttachments(options): Promise<PaginatedFindResult<AttachmentEntity>>;
    normalizeAttachment(attachment, normalizer?): Promise<AttachmentResponse>;
    normalizeAttachments(attachments): Promise<AttachmentResponse[]>;
    updateAttachment(attachmentId, attachmentPartial): Promise<{
        id: string;
    }>;
}

Implemented by

Methods

createAttachment deleteAttachment generateUploadSignedUrl getBucket getDb getOneAttachment getPaginatedAttachments normalizeAttachment normalizeAttachments updateAttachment

Methods

createAttachment

deleteAttachment

generateUploadSignedUrl

  • generateUploadSignedUrl(filename, contentType, contentLength): Promise<string>

  • generate upload signed url

    Parameters

    • filename: string

      : filename

    • contentType: string

      : content type

    • contentLength: number

      : content length

    Returns Promise<string>

    : signed url

    Memberof

    AttachmentService

    Throws

    : if error

getBucket

getDb

getOneAttachment

getPaginatedAttachments

normalizeAttachment

normalizeAttachments

updateAttachment

  • updateAttachment(attachmentId, attachmentPartial): Promise<{
        id: string;
    }>

  • Update attachment by id

    Parameters

    • attachmentId: string

      attachment id

    • attachmentPartial: Partial<Attachment>

      attachment data for update

    Returns Promise<{
        id: string;
    }>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc