Function: createComment()

function createComment(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  actor?: {
   [key: string]: unknown;
     avatarUrl?: string;
     displayName?: string;
     html?: string;
     isDeleted?: boolean;
     key?: string;
     lastSeenVersion?: string;
     name?: string;
     renderedLink?: string;
  };
  canDelete?: boolean;
  canEdit?: boolean;
  comment?: string;
  commentOutput?: string;
  created?: Date;
  id?: number;
  objectId?: number;
  role?: number;
  updated?: Date;
}>;

Defined in: src/assetsServer/api/comments.ts:8

Add a comment to an object.

Parameters

Parameter	Type
client	Client
parameters	{ actor?: { avatarUrl?: string; displayName?: string; html?: string; isDeleted?: boolean; key?: string; lastSeenVersion?: string; name?: string; renderedLink?: string; }; canDelete?: boolean; canEdit?: boolean; comment?: string; commentOutput?: string; created?: unknown; id?: number; objectId?: number; role?: number; updated?: unknown; }
parameters.actor?	{ avatarUrl?: string; displayName?: string; html?: string; isDeleted?: boolean; key?: string; lastSeenVersion?: string; name?: string; renderedLink?: string; }
parameters.actor.avatarUrl?	string
parameters.actor.displayName?	string
parameters.actor.html?	string
parameters.actor.isDeleted?	boolean
parameters.actor.key?	string
parameters.actor.lastSeenVersion?	string
parameters.actor.name?	string
parameters.actor.renderedLink?	string
parameters.canDelete?	boolean
parameters.canEdit?	boolean
parameters.comment?	string
parameters.commentOutput?	string
parameters.created?	unknown
parameters.id?	number
parameters.objectId?	number
parameters.role?	number
parameters.updated?	unknown
options?	RequestOptions

Returns

Promise<{ [key: string]: unknown; actor?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; html?: string; isDeleted?: boolean; key?: string; lastSeenVersion?: string; name?: string; renderedLink?: string; }; canDelete?: boolean; canEdit?: boolean; comment?: string; commentOutput?: string; created?: Date; id?: number; objectId?: number; role?: number; updated?: Date; }>