Function: addComment()

function addComment(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  author?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  body?: string;
  created?: string;
  id?: string;
  properties?: object[];
  renderedBody?: string;
  self?: string;
  updateAuthor?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  updated?: string;
  visibility?: {
   [key: string]: unknown;
     type?: "role" | "group" | string & object;
     value?: string;
  };
}>;

Defined in: src/server/api/issues.ts:574

Adds a new comment to an issue.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ author?: { active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; body?: string; created?: string; expand?: string; id?: string; issueIdOrKey: string; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; updated?: string; visibility?: { type?: "role" | "group" | string & object; value?: string; }; }	-
parameters.author?	{ active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }	-
parameters.author.active?	boolean	-
parameters.author.avatarUrls?	Record<string, string>	-
parameters.author.displayName?	string	-
parameters.author.emailAddress?	string	-
parameters.author.key?	string	-
parameters.author.name?	string	-
parameters.author.self?	string	-
parameters.author.timeZone?	string	-
parameters.body?	string	-
parameters.created?	string	-
parameters.expand?	string	Optional flags: renderedBody (provides body rendered in HTML)
parameters.id?	string	-
parameters.issueIdOrKey?	string	Issue id or key
parameters.properties?	object[]	-
parameters.renderedBody?	string	-
parameters.self?	string	-
parameters.updateAuthor?	{ active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }	-
parameters.updateAuthor.active?	boolean	-
parameters.updateAuthor.avatarUrls?	Record<string, string>	-
parameters.updateAuthor.displayName?	string	-
parameters.updateAuthor.emailAddress?	string	-
parameters.updateAuthor.key?	string	-
parameters.updateAuthor.name?	string	-
parameters.updateAuthor.self?	string	-
parameters.updateAuthor.timeZone?	string	-
parameters.updated?	string	-
parameters.visibility?	{ type?: "role" | "group" | string & object; value?: string; }	-
parameters.visibility.type?	"role" | "group" | string & object	-
parameters.visibility.value?	string	-
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; author?: { [key: string]: unknown; active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; body?: string; created?: string; id?: string; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { [key: string]: unknown; active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; updated?: string; visibility?: { [key: string]: unknown; type?: "role" | "group" | string & object; value?: string; }; }>