Loading ...

REST API: Comment Overview | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Comments » REST API: Comment Overview
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 11

REST API: Comment Overview

0 
 /5
0 (0votes)

Comment Properties

A comment is a statement of fact or opinion, that expresses a personal reaction or attitude on the entity object. It includes the Comment ID that is used to make reference to the particular comment throughout the system. Each Comment ID is unique and automatically generated. Comments can be made on Entities such as Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas, Photos, Events.

Description
Attributes Notes Data type
AuthorID Author's unique ID. int
CanUserChangeCommentStatus Specifies if the user can change comment status. bool
CanUserDeleteComment Specifies if the user can delete comments. bool
CommentEntityType EntityType of Comment which depends on the EntityType of the Content on which Comment is made. Generated automatically. This cannot be changed. SystemEntityType
CommentID ID value which uniquely identifies each comment in the Communifire. Generated automatically. This cannot be changed. int
CommentRating Rating of comment. float
CommentStatus Status of the comment. The values of EntityCommentStatus are:
  • Pending = 0
  • Approved = 1
  • Spam = 2
  • Declined = 3
  • All = 4
 EntityCommentStatus
CommentText This is the actual text which is entered by the user as comment. string
DateCommented Date when the comment was made. datetime
DateCommentedText Date (string) when the comment was made. string
DateTimeFull Date and time in "Day, Month DD, YYYY at HH:MM" format. string
DateTimeISO Date and time in ISO format. string
EntityID Unique ID of the entity on which comment is made. int
EntityType EntityType of content on which comment is made. SystemEntityType
ParentCommentID Unique ID of the comment under which the comment is made. int
SpaceID Unique ID of space. int
UserAvatarFileName Name of user's profile image. string
UserAvatarVirtualPath URL of the user's avatar image. string
UserDisplayName Display name of the user who made the comment. string
UserEmail Email ID of the user who made the comment. string
UserFirstName First name of the user who made the comment. string
UserID Unique ID of the user who made the comment. int
UserIPAddress IP address of the user who made the comment. string
UserLastName
 Last name of the user who made the comment. string
UserName User name of the user who made the comment. string
UserProfileURL URL of the user's profile who made the comment. string
UserWebsite Website of the user who made the comment. string

Please Note Refer this wiki on how to create a new comment via REST API.

Wiki Index

Pages

Intranet Software