projectmanager-sdk
Version:
Software development kit for the ProjectManager.com API. for TypeScript
64 lines (63 loc) • 2.36 kB
TypeScript
/**
* ProjectManager API for TypeScript
*
* (c) ProjectManager.com, Inc.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @author ProjectManager.com <support@projectmanager.com>
* @copyright ProjectManager.com, Inc.
* @link https://github.com/projectmgr/projectmanager-sdk-typescript
*/
import { DiscussionEmoji } from "../index.js";
import { DiscussionCommentFileDto } from "../index.js";
/**
* Tasks can have discussions attached to them. These discussions can include text with simple
* formatting. Discussion comments are formatted using [Markdown](https://www.markdownguide.org/)
* and users should be aware that HTML embedding is not permitted due to the risk of cross-site
* attacks and other embedding challenges.
*/
export type DiscussionCommentDto = {
/**
* The unique ID of the discussion comment.
*/
id: string;
/**
* The text of the comment to add to the discussion, in Markdown format.
*
* Discussion comments are formatted using [Markdown](https://www.markdownguide.org/)
* and users should be aware that HTML embedding is not permitted due to the risk of cross-site
* attacks and other embedding challenges.
*/
text: string | null;
/**
* The unique ID of the resource that wrote this comment.
*/
authorId: string;
/**
* The unique ID of the resource that wrote this comment.
*/
authorName: string | null;
/**
* The timestamp when the comment was created.
*/
createDate: string;
/**
* The timestamp when the comment was modified, if it is different from the create date.
*/
modifyDate: string | null;
/**
* The list of emoji reactions to this discussion comment, if any. This object will
* be null if no emoji reactions have been recorded on this discussion comment.
*/
emoji: DiscussionEmoji[] | null;
/**
* The list of files associated with this Comment, if any.
*
* This field will be present when you fetch a single object.
* When you query for multiple objects, this field is not included in results by default.
* To expand this field, specify the name of this field in the `$expand` parameter.
*/
files: DiscussionCommentFileDto[] | null;
};