Interface IAnnotationsClient

interface IAnnotationsClient {
    createAnnotation(
        args: {
            entryId: number;
            pageNumber: number;
            repositoryId: string;
            request: LfRepositoryClientV2.Annotation;
        },
    ): Promise<LfRepositoryClientV2.Annotation>;
    createAnnotationReason(
        args: {
            repositoryId: string;
            request: LfRepositoryClientV2.AnnotationReasonRequest;
        },
    ): Promise<LfRepositoryClientV2.AnnotationReason>;
    deleteAnnotation(
        args: {
            entryId: number;
            itemId: number;
            pageNumber: number;
            repositoryId: string;
        },
    ): Promise<void>;
    deleteAnnotationReason(
        args: { force?: boolean; reasonId: number; repositoryId: string },
    ): Promise<void>;
    getAnnotation(
        args: {
            entryId: number;
            itemId: number;
            pageNumber: number;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.Annotation>;
    getAnnotationAttachment(
        args: {
            entryId: number;
            itemId: number;
            pageNumber: number;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.FileResponse>;
    listAnnotationReasons(
        args: {
            count?: boolean;
            orderby?: null | string;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.AnnotationReason[]>;
    listDocumentAnnotations(
        args: {
            count?: boolean;
            entryId: number;
            orderby?: null | string;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.Annotation[]>;
    listPageAnnotations(
        args: {
            count?: boolean;
            entryId: number;
            orderby?: null | string;
            pageNumber: number;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.Annotation[]>;
    updateAnnotation(
        args: {
            entryId: number;
            itemId: number;
            pageNumber: number;
            repositoryId: string;
            request: LfRepositoryClientV2.Annotation;
        },
    ): Promise<LfRepositoryClientV2.Annotation>;
    updateAnnotationReason(
        args: {
            reasonId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.AnnotationReasonRequest;
        },
    ): Promise<LfRepositoryClientV2.AnnotationReason>;
    uploadAnnotationAttachment(
        args: {
            entryId: number;
            file?: LfRepositoryClientV2.FileParameter;
            itemId: number;
            pageNumber: number;
            repositoryId: string;
        },
    ): Promise<void>;
    uploadAnnotationImage(
        args: {
            entryId: number;
            file?: LfRepositoryClientV2.FileParameter;
            itemId: number;
            pageNumber: number;
            repositoryId: string;
        },
    ): Promise<void>;
}

Implemented by

Methods

createAnnotation createAnnotationReason deleteAnnotation deleteAnnotationReason getAnnotation getAnnotationAttachment listAnnotationReasons listDocumentAnnotations listPageAnnotations updateAnnotation updateAnnotationReason uploadAnnotationAttachment uploadAnnotationImage

Methods

createAnnotation

  • createAnnotation(
        args: {
            entryId: number;
            pageNumber: number;
            repositoryId: string;
            request: LfRepositoryClientV2.Annotation;
        },
    ): Promise<LfRepositoryClientV2.Annotation>
    • The request body is a polymorphic annotation discriminated by annotationType; supply the writable members for that type.
    • For attachment and bitmap annotations, create the annotation first, then upload its binary content via the dedicated sub-resource.
    • Requires the "annotate" entry right.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.Annotation>

    Successfully created the annotation. Returned the created annotation.

createAnnotationReason

deleteAnnotation

  • deleteAnnotation(
        args: {
            entryId: number;
            itemId: number;
            pageNumber: number;
            repositoryId: string;
        },
    ): Promise<void>
    • Requires the "annotate" entry right.
    • Required OAuth scope: repository.Write

    Parameters

    • args: { entryId: number; itemId: number; pageNumber: number; repositoryId: string }

    Returns Promise<void>

    Successfully deleted the annotation.

deleteAnnotationReason

  • deleteAnnotationReason(
        args: { force?: boolean; reasonId: number; repositoryId: string },
    ): Promise<void>
    • When force is false, deleting a reason that is in use fails.
    • Required OAuth scope: repository.Write

    Parameters

    • args: { force?: boolean; reasonId: number; repositoryId: string }
      • Optionalforce?: boolean

        (optional)

      • reasonId: number
      • repositoryId: string

    Returns Promise<void>

    Successfully deleted the annotation reason.

getAnnotation

  • getAnnotation(
        args: {
            entryId: number;
            itemId: number;
            pageNumber: number;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.Annotation>
    • Returns the annotation, typed by annotation type.
    • Requires the "see annotations" entry right; redaction content is only revealed to callers with the "see through redactions" right.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          entryId: number;
          itemId: number;
          pageNumber: number;
          repositoryId: string;
          select?: null | string;
      }
      • entryId: number

        The document entry ID.

      • itemId: number

        The annotation item ID, unique within the page.

      • pageNumber: number

        The 1-based page number.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.Annotation>

    Successfully returned the requested annotation.

getAnnotationAttachment

  • getAnnotationAttachment(
        args: {
            entryId: number;
            itemId: number;
            pageNumber: number;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.FileResponse>
    • Streams the attached file. Fails with a bad request if the annotation is not an attachment.
    • Requires the "see annotations" entry right.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          entryId: number;
          itemId: number;
          pageNumber: number;
          repositoryId: string;
          select?: null | string;
      }
      • entryId: number

        The document entry ID.

      • itemId: number

        The attachment annotation's item ID.

      • pageNumber: number

        The 1-based page number.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.FileResponse>

    Successfully returned the content of the attachment annotation.

listAnnotationReasons

  • listAnnotationReasons(
        args: {
            count?: boolean;
            orderby?: null | string;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.AnnotationReason[]>
    • Returns the redaction reasons defined in the repository.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          count?: boolean;
          orderby?: null | string;
          repositoryId: string;
          select?: null | string;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalorderby?: null | string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.AnnotationReason[]>

    Successfully returned the repository's annotation reasons.

listDocumentAnnotations

  • listDocumentAnnotations(
        args: {
            count?: boolean;
            entryId: number;
            orderby?: null | string;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.Annotation[]>
    • Returns every annotation on every page of the document, as a polymorphic list keyed by annotation type.
    • Requires the "see annotations" entry right; redaction content is only revealed to callers with the "see through redactions" right.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          count?: boolean;
          entryId: number;
          orderby?: null | string;
          repositoryId: string;
          select?: null | string;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • entryId: number

        The document entry ID.

      • Optionalorderby?: null | string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.Annotation[]>

    Successfully returned the annotations on the document.

listPageAnnotations

  • listPageAnnotations(
        args: {
            count?: boolean;
            entryId: number;
            orderby?: null | string;
            pageNumber: number;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.Annotation[]>
    • Returns the annotations on the requested page, as a polymorphic list keyed by annotation type.
    • Requires the "see annotations" entry right; redaction content is only revealed to callers with the "see through redactions" right.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          count?: boolean;
          entryId: number;
          orderby?: null | string;
          pageNumber: number;
          repositoryId: string;
          select?: null | string;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • entryId: number

        The document entry ID.

      • Optionalorderby?: null | string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • pageNumber: number

        The 1-based page number.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.Annotation[]>

    Successfully returned the annotations on the page.

updateAnnotation

  • updateAnnotation(
        args: {
            entryId: number;
            itemId: number;
            pageNumber: number;
            repositoryId: string;
            request: LfRepositoryClientV2.Annotation;
        },
    ): Promise<LfRepositoryClientV2.Annotation>
    • Supply only the members to change; omitted members are left unchanged. The annotationType must match the existing annotation.
    • Requires the "annotate" entry right.
    • Required OAuth scope: repository.Write

    Parameters

    • args: {
          entryId: number;
          itemId: number;
          pageNumber: number;
          repositoryId: string;
          request: LfRepositoryClientV2.Annotation;
      }

    Returns Promise<LfRepositoryClientV2.Annotation>

    Successfully updated the annotation. Returned the updated annotation.

updateAnnotationReason

uploadAnnotationAttachment

  • uploadAnnotationAttachment(
        args: {
            entryId: number;
            file?: LfRepositoryClientV2.FileParameter;
            itemId: number;
            pageNumber: number;
            repositoryId: string;
        },
    ): Promise<void>
    • Send the file as multipart/form-data under the form field "file". The annotation must already exist and be an attachment annotation.
    • Requires the "annotate" entry right.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<void>

    Successfully uploaded the attachment content.

uploadAnnotationImage

  • uploadAnnotationImage(
        args: {
            entryId: number;
            file?: LfRepositoryClientV2.FileParameter;
            itemId: number;
            pageNumber: number;
            repositoryId: string;
        },
    ): Promise<void>
    • Send the image as multipart/form-data under the form field "file". The annotation must already exist and be a bitmap annotation.
    • Requires the "annotate" entry right.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<void>

    Successfully uploaded the bitmap annotation image.

Settings

Member Visibility

On This Page

Methods