Function: updateInlineComment()

function updateInlineComment(client, parameters): Promise<{
[key: string]: unknown;
  _links?:   | {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
   }
     | null;
  blogPostId?: string;
  body?:   | {
   [key: string]: unknown;
     atlas_doc_format?:   | {
      [key: string]: unknown;
        representation?: string;
        value?: string;
      }
        | null;
     storage?:   | {
      [key: string]: unknown;
        representation?: string;
        value?: string;
      }
        | null;
     view?:   | {
      [key: string]: unknown;
        representation?: string;
        value?: string;
      }
        | null;
   }
     | null;
  id?: string;
  likes?:   | {
   [key: string]: unknown;
     _links?:   | {
      [key: string]: unknown;
        base?: string;
        byOperation?: string;
        collection?: string;
        context?: string;
        download?: string;
        editui?: string;
        edituiv2?: string;
        next?: string;
        prev?: string;
        self?: string;
        tinyui?: string;
        webui?: string;
      }
        | null;
     meta?:   | {
      [key: string]: unknown;
        count?: number;
        cursor?: string;
        hasMore?: boolean;
      }
        | null;
     results?: object[] | null;
   }
     | null;
  operations?:   | {
   [key: string]: unknown;
     _links?:   | {
      [key: string]: unknown;
        base?: string;
        byOperation?: string;
        collection?: string;
        context?: string;
        download?: string;
        editui?: string;
        edituiv2?: string;
        next?: string;
        prev?: string;
        self?: string;
        tinyui?: string;
        webui?: string;
      }
        | null;
     meta?:   | {
      [key: string]: unknown;
        count?: number;
        cursor?: string;
        hasMore?: boolean;
      }
        | null;
     results?: object[] | null;
   }
     | null;
  pageId?: string;
  parentCommentId?: string;
  properties?:   | {
   [key: string]: unknown;
     _links?:   | {
      [key: string]: unknown;
        base?: string;
        byOperation?: string;
        collection?: string;
        context?: string;
        download?: string;
        editui?: string;
        edituiv2?: string;
        next?: string;
        prev?: string;
        self?: string;
        tinyui?: string;
        webui?: string;
      }
        | null;
     inline-marker-ref?: string;
     inline-original-selection?: string;
     inlineMarkerRef?: string;
     inlineOriginalSelection?: string;
     meta?:   | {
      [key: string]: unknown;
        count?: number;
        cursor?: string;
        hasMore?: boolean;
      }
        | null;
     results?: object[] | null;
   }
     | null;
  resolutionLastModifiedAt?: Date;
  resolutionLastModifierId?: string;
  resolutionStatus?: "open" | "reopened" | "resolved" | "dangling";
  status?:   | "deleted"
     | "any"
     | "current"
     | "historical"
     | "draft"
     | "trashed"
     | "archived";
  title?: string;
  version?:   | {
   [key: string]: unknown;
     attachment?: Record<string, any>;
     authorId?: string;
     comment?: Record<string, any>;
     contributorIds?: unknown[];
     createdAt?: Date;
     message?: string | null;
     minorEdit?: boolean;
     ncsStepVersion?: string | null;
     number?: number;
   }
     | null;
  versions?:   | {
   [key: string]: unknown;
     _links?:   | {
      [key: string]: unknown;
        base?: string;
        byOperation?: string;
        collection?: string;
        context?: string;
        download?: string;
        editui?: string;
        edituiv2?: string;
        next?: string;
        prev?: string;
        self?: string;
        tinyui?: string;
        webui?: string;
      }
        | null;
     meta?:   | {
      [key: string]: unknown;
        count?: number;
        cursor?: string;
        hasMore?: boolean;
      }
        | null;
     results?: object[] | null;
   }
     | null;
}>;

Defined in: src/v2/api/comment.ts:442

Update an inline comment. This can be used to update the body text of a comment and/or to resolve the comment

Permissions required: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ body?: | { [key: string]: unknown; representation?: "storage" | "wiki" | "atlas_doc_format"; value?: string; } | { [key: string]: unknown; atlas_doc_format?: | { [key: string]: unknown; representation?: "storage" | "wiki" | "atlas_doc_format"; value?: string; } | null; storage?: | { [key: string]: unknown; representation?: "storage" | "wiki" | "atlas_doc_format"; value?: string; } | null; wiki?: | { [key: string]: unknown; representation?: "storage" | "wiki" | "atlas_doc_format"; value?: string; } | null; } | null; commentId: number; resolved?: boolean; version?: | { [key: string]: unknown; message?: string; number?: number; } | null; }	-
parameters.body?	| { [key: string]: unknown; representation?: "storage" | "wiki" | "atlas_doc_format"; value?: string; } | { [key: string]: unknown; atlas_doc_format?: | { [key: string]: unknown; representation?: "storage" | "wiki" | "atlas_doc_format"; value?: string; } | null; storage?: | { [key: string]: unknown; representation?: "storage" | "wiki" | "atlas_doc_format"; value?: string; } | null; wiki?: | { [key: string]: unknown; representation?: "storage" | "wiki" | "atlas_doc_format"; value?: string; } | null; } | null	-
parameters.commentId	number	The ID of the comment to be retrieved.
parameters.resolved?	boolean	Resolved state of the comment. Set to true to resolve the comment, set to false to reopen it. If matching the existing state (i.e. true -> resolved or false -> open/reopened) , no change will occur. A dangling comment cannot be updated.
parameters.version?	| { [key: string]: unknown; message?: string; number?: number; } | null	-

Returns

Promise<{ [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; blogPostId?: string; body?: | { [key: string]: unknown; atlas_doc_format?: | { [key: string]: unknown; representation?: string; value?: string; } | null; storage?: | { [key: string]: unknown; representation?: string; value?: string; } | null; view?: | { [key: string]: unknown; representation?: string; value?: string; } | null; } | null; id?: string; likes?: | { [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; meta?: | { [key: string]: unknown; count?: number; cursor?: string; hasMore?: boolean; } | null; results?: object[] | null; } | null; operations?: | { [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; meta?: | { [key: string]: unknown; count?: number; cursor?: string; hasMore?: boolean; } | null; results?: object[] | null; } | null; pageId?: string; parentCommentId?: string; properties?: | { [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; inline-marker-ref?: string; inline-original-selection?: string; inlineMarkerRef?: string; inlineOriginalSelection?: string; meta?: | { [key: string]: unknown; count?: number; cursor?: string; hasMore?: boolean; } | null; results?: object[] | null; } | null; resolutionLastModifiedAt?: Date; resolutionLastModifierId?: string; resolutionStatus?: "open" | "reopened" | "resolved" | "dangling"; status?: | "deleted" | "any" | "current" | "historical" | "draft" | "trashed" | "archived"; title?: string; version?: | { [key: string]: unknown; attachment?: Record<string, any>; authorId?: string; comment?: Record<string, any>; contributorIds?: unknown[]; createdAt?: Date; message?: string | null; minorEdit?: boolean; ncsStepVersion?: string | null; number?: number; } | null; versions?: | { [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; meta?: | { [key: string]: unknown; count?: number; cursor?: string; hasMore?: boolean; } | null; results?: object[] | null; } | null; }>