Interface AttachmentApi

Namespace returned by Source.attachments. Adapters that do not advertise the attachments capability throw HonuaCapabilityNotSupportedError from each method rather than ship a null-ish placeholder.

interface AttachmentApi {
    add(request: AttachmentAdd): Promise<AttachmentEditOutcome>;
    delete(request: AttachmentDelete): Promise<readonly AttachmentEditOutcome[]>;
    list(parentId: FeatureId, options?: {
        signal?: AbortSignal;
    }): Promise<readonly AttachmentInfo[]>;
    query(request?: AttachmentQuery): Promise<readonly AttachmentGroup[]>;
    update(request: AttachmentUpdate): Promise<AttachmentEditOutcome>;
}

Index

Methods

add delete list query update

Methods

add

add(request): Promise<AttachmentEditOutcome>
Parameters
- request: AttachmentAdd
Returns Promise<AttachmentEditOutcome>
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:771

delete

delete(request): Promise<readonly AttachmentEditOutcome[]>
Parameters
- request: AttachmentDelete
Returns Promise<readonly AttachmentEditOutcome[]>
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:773

list

list(parentId, options?): Promise<readonly AttachmentInfo[]>
Parameters
- parentId: FeatureId
- Optionaloptions: {
  signal?: AbortSignal;
  }
  - Optionalsignal?: AbortSignal
Returns Promise<readonly AttachmentInfo[]>
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:770

query

query(request?): Promise<readonly AttachmentGroup[]>
Parameters
- Optionalrequest: AttachmentQuery
Returns Promise<readonly AttachmentGroup[]>
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:769

update

update(request): Promise<AttachmentEditOutcome>
Parameters
- request: AttachmentUpdate
Returns Promise<AttachmentEditOutcome>
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:772