@dokieli/web-annotation - v1.0.1
    Preparing search index...

    Interface CreateAnnotationParams

    interface CreateAnnotationParams {
        body?: {
            content?: string;
            format?: string;
            language?: string;
            license?: string;
            purpose?: Purpose;
            rights?: string;
            tags?: string;
        };
        canonical?: string;
        creator?: AnnotationCreator;
        datetime?: string;
        id?: string;
        iri?: string;
        language?: string;
        license?: string;
        motivatedBy: string;
        rights?: string;
        target: AnnotationTarget;
    }
    Index
    body? canonical? creator? datetime? id? iri? language? license? motivatedBy rights? target

    Optionalbody

    body?: {
        content?: string;
        format?: string;
        language?: string;
        license?: string;
        purpose?: Purpose;
        rights?: string;
        tags?: string;
    }

    Type Declaration

    • Optionalcontent?: string

      Optional; empty/omitted content is allowed

    • Optionalformat?: string

      media type of content; defaults to text/html

    • Optionallanguage?: string

      Body content language (BCP-47)

    • Optionallicense?: string

      Body-specific license IRI

    • Optionalpurpose?: Purpose

      well-known token (tagging/oa:tagging/IRI) or any other purpose as a full IRI (see Purpose)

    • Optionalrights?: string

      Body-specific rights IRI

    • Optionaltags?: string

      Comma-separated tag string

    canonical?: string

    Optional stable identifier; emitted as oa:canonical only when provided

    creator?: AnnotationCreator
    datetime?: string

    A timestamp in xsd:dateTime format - defaults to now

    id?: string

    UUID - generated via crypto.randomUUID() if omitted

    iri?: string

    Subject IRI used verbatim by both serializers (e.g. '' for write-then-POST, or a base#fragment)

    language?: string

    Annotation-level language (BCP-47); independent of body.language

    license?: string

    Annotation-level license IRI; independent of body.license

    motivatedBy: string

    Required. Motivation IRI, e.g. oa:replying, oa:highlighting, as:Like

    rights?: string

    Annotation-level rights IRI; independent of body.rights

    target: AnnotationTarget

    Settings
    Member Visibility

    On This Page
    Properties