DocumentFeed Class Reference

The DocumentFeed class represents social collaboration activity on Document Library files. This class tracks comments, likes, ratings, and other user interactions with documents, enabling social collaboration features within the Document Library module.

Overview

The DocumentFeed class captures all social collaboration activities related to Document Library files. Each DocumentFeed record represents a single activity event such as a comment, like, rating, or document attachment. This enables tracking, notifications, and engagement analytics for document collaboration.

Key Characteristics:

• Tracks social collaboration activities on documents
• Supports comments with rich text (max 5,000 characters)
• Like/dislike voting system with counts
• Rating functionality for documents
• @mention support for user notifications
• Access level controls for visibility
• Roll-up counts for engagement metrics

Entity Name:DocumentFeed

Common Feed Types:

• Post - User comments and messages
• Comment - Responses to posts
• Document - Document attachment activities
• Rating - Document rating events

DocumentFeed Properties Reference

Core Properties

User and Ownership

Engagement Metrics

Access Control

Related Entities

System Metadata

Property Details

Id

System-generated unique identifier for the feed record.

Type: string
Required: Auto-generated
Read-Only: Yes

Description: Automatically generated by the platform when the DocumentFeed record is created. Used for querying, updating, and referencing specific feed items.

Name

Title or subject line for the feed item.

Type: string
Required: No
Max Length: 255 characters

Description: Optional title that appears as the heading for the feed item. Commonly used for structured posts or announcements. If not provided, the feed item displays without a title.

Usage:

• Post titles
• Announcement subjects
• Structured content headings

Type

Describes the kind of feed item.

Type: string
Required: No
Max Length: 255 characters

Valid Values:

• "Post" - User comment or message
• "Comment" - Response to another post
• "Document" - Document attachment activity
• "Rating" - Document rating event

Description: Indicates the feed item's purpose and how it should be displayed. The Type determines which properties are relevant and how the system processes the feed item.

Comment

The text body of the feed item.

Type: string (TextArea)
Required: No
Max Length: 5,000 characters

Description: Contains the main content of the feed item, including user comments, messages, or audit information. Supports rich text formatting and @mentions for user notifications.

Features:

• Rich text formatting
• @mention support (@username)
• Line breaks and paragraphs
• Maximum 5,000 characters

Usage:

• User comments on documents
• Discussion posts
• Collaboration messages
• Audit trail information

ParentId

Reference to the parent Document record.

Type: string (Lookup)
Required: No

Description: Links the feed item to a specific Document in the Document Library. All social collaboration activities for a document reference that document's ID in the ParentId field.

Usage:

• Associates comments with documents
• Links ratings to documents
• Connects feed items to file records
• Enables activity filtering by document

OwnerId

The user context under which the feed was posted.

Type: string (Lookup - User)
Required: No

Description: Represents the "owner" or context user for the feed item. Typically the same as CreatedById but can differ in cases where content is posted on behalf of another user or in a specific user context.

CreatedById

The user who originally created the feed record.

Type: string (Lookup - User)
Required: Auto-generated
Read-Only: Yes

Description: Automatically set to the ID of the user who created the feed item. Cannot be modified after creation. Used for attribution, permissions, and activity tracking.

Usage:

• Displays author name in feed
• Controls edit permissions
• Activity tracking and analytics
• Audit trail

ModifiedById

The user who last edited the feed item.

Type: string (Lookup - User)
Required: Auto-generated
Read-Only: Yes

Description: Automatically updated to the ID of the user who most recently modified the feed item. Used for tracking edit history and audit trails.

AssignedUserId

User assigned to a task or assignment feed item.

Type: string (Lookup - User)
Required: No

Description: If the feed item represents a task or assignment, this field contains the ID of the user responsible for completing it. Used for task management and assignment tracking within collaboration workflows.

Usage:

• Task assignments
• Action item tracking
• Responsibility designation

LikeCount

Total number of likes received by the feed item.

Type: int (Rollup Summary)
Required: No
Read-Only: Yes

Description: Automatically calculated count of users who have liked the feed item. Roll-up summary field that updates when users add or remove likes. Cannot be set manually.

Usage:

• Engagement metrics
• Popular content identification
• User feedback measurement

DisLikeCount

Total number of dislikes received by the feed item.

Type: int (Rollup Summary)
Required: No
Read-Only: Yes

Description: Automatically calculated count of users who have disliked the feed item. Roll-up summary field that updates when users add or remove dislikes. Cannot be set manually.

Usage:

• Feedback collection
• Content quality indicators
• Engagement analytics

CommentCount

Total number of direct comments on the feed item.

Type: int (Rollup Summary)
Required: No
Read-Only: Yes

Description: Automatically calculated count of comment-type feed items that reference this feed item as their parent. Updates dynamically as comments are added or removed. Cannot be set manually.

Usage:

• Engagement metrics
• Discussion activity tracking
• Content popularity indicators

Rating

Numeric rating value for the feed item.

Type: int (Number)
Required: No
Range: 0-6

Description: Optional numeric rating that can be attached to feed items, particularly for document ratings. The scale and meaning of rating values is configurable based on organizational needs.

Common Rating Scales:

• 0-5 stars (where 0 = no rating)
• 1-5 scale
• Custom organizational scales

Usage:

• Document quality ratings
• Content feedback
• User satisfaction measurement

AccessLevel

Numerical code indicating feed item visibility.

Type: int (Number)
Required: No
Range: 0-3

Valid Values:

• 0 - Owner only
• 1 - Internal users (employees)
• 2 - Everyone with access
• 3 - Public (including guest users)

Description: Controls who can view the feed item based on user types and permissions. Works in conjunction with underlying document permissions and folder sharing settings.

Access Level Meanings:

• 0 (Owner): Only document owner can view
• 1 (Internal Users): All employee users with folder access can view
• 2 (Everyone with Access): All users with document access can view
• 3 (Public): Everyone including guest users can view

IsVoteUpdatable

Controls whether users can change their like/dislike vote.

Type: bool (Checkbox)
Required: No
Default: false

Description: When true, users can modify their like/dislike vote after the initial vote. When false, votes are permanent once cast. Provides flexibility in how voting systems are implemented.

Usage:

• Flexible voting systems
• Poll configuration
• User feedback mechanisms

EntityId

Reference to a related entity record.

Type: string (Lookup - Entity)
Required: No

Description: Links the feed item to a specific entity record, such as an Article Post or other content type. Used when feed items relate to entities beyond just documents.

Usage:

• Cross-entity activity tracking
• Related content linking
• Broad collaboration scenarios

CreatedOn

Timestamp when the feed item was posted.

Type: DateTime
Required: Auto-generated
Read-Only: Yes

Description: Automatically set to the date and time when the feed record was created. Used for chronological sorting, activity timelines, and audit trails.

Usage:

• Sort feed items chronologically
• Activity timeline displays
• Time-based filtering
• Audit trails

ModifiedOn

Timestamp of the most recent edit.

Type: DateTime
Required: Auto-generated
Read-Only: Yes

Description: Automatically updated to the date and time whenever the feed record is modified. Used for tracking edit history and displaying "last updated" information.

Usage:

• Edit tracking
• Recent activity sorting
• Change audit trails

SourceIP

IP address from which the feed item was submitted.

Type: string
Required: No
Max Length: 18 characters

Description: Captures the IP address of the client that created the feed item. Used for security auditing, abuse prevention, and compliance tracking.

Format:

• IPv4: "192.168.1.1"
• IPv6: Shortened format within 18 characters

Usage:

• Security auditing
• Abuse detection
• Compliance tracking
• Geographic analytics

IsDeleted

Soft-delete flag indicating the feed is in the recycle bin.

Type: bool (Checkbox)
Required: No
Default: false

Description: When true, the feed item is marked as deleted and moved to the recycle bin. Allows for recovery of accidentally deleted content. Feed items with IsDeleted=true are hidden from normal views.

Usage:

• Soft delete functionality
• Content recovery
• Audit trail preservation

Access Level Details

Owner Only (AccessLevel = 0)

Feed item visible only to the document owner.

Use Cases:

• Private notes to owner
• Confidential feedback
• Owner-specific communications

Visibility:

• Document owner can view
• Administrators can view (override)
• All other users cannot view

Internal Users (AccessLevel = 1)

Feed item visible to all employee users with folder access.

Use Cases:

• Internal team discussions
• Employee-only collaboration
• Internal documentation comments

Visibility:

• All employee users with appropriate permissions
• Respects folder sharing permissions
• Partners and customers cannot view
• Guest users cannot view

Everyone with Access (AccessLevel = 2)

Feed item visible to all users with document access.

Use Cases:

• General collaboration
• Cross-organization discussions
• Standard comments and feedback

Visibility:

• All authenticated users with document access
• Respects underlying document permissions
• Includes partners and customers with access
• Guest users excluded unless document is public

Public (AccessLevel = 3)

Feed item visible to everyone including guest users.

Use Cases:

• Public announcements
• External community engagement
• Public feedback collection

Visibility:

• All authenticated users
• Guest users (if enabled)
• Public web access (if configured)
• Broadest visibility level