Function createAnnotation

Parameters

• connectionOptions: {
      apiUrl: string;
      headers: Object;
  }

  • apiUrl: string

    Target annotation database API URL

  • headers: Object

    Headers responsible for authenticating the request and the Hypothes.is Accept header

• newAnnotation: {
      document?: { title?: string[] | undefined; dc?: { identifier?: string[] | undefined; } | undefined; highwire?: { doi?: string[] | undefined; pdf_url?: string[] | undefined; } | undefined; link?: { href: string; type?: string | undefined; }[] | undefined; };
      group?: string;
      permissions?: any;
      references?: string[];
      tags?: string[];
      target?: { selector: { type: string; }[]; };
      text?: string;
      uri: string;
  }

  Annotation to be created

  • Optional document?: { title?: string[] | undefined; dc?: { identifier?: string[] | undefined; } | undefined; highwire?: { doi?: string[] | undefined; pdf_url?: string[] | undefined; } | undefined; link?: { href: string; type?: string | undefined; }[] | undefined; }

  • Optional group?: string

  • Optional permissions?: any

  • Optional references?: string[]

  • Optional tags?: string[]

  • Optional target?: { selector: { type: string; }[]; }

  • Optional text?: string

  • uri: string