Forum In-Process API Supplementary Type

Verint | Telligent Community — Wed, 14 May 2025 16:46:43 GMT

Current Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 16:46:43

Content created on the site must implement this interface for the social services to support it.

Forum is defined in the Telligent.Evolution.Extensibility.Api.Entities.Version1 namespace.

Definition

class Forum : LazyContentApiEntityWithExtendedAttributes<ILegacyApplication>, IApiEntity, [[IApplication In-Process API Supplementary Type|IApplication]], IAuditable, [[IContent In-Process API Event Argument|IContent]]
{
	Forum([[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]] additionalInfo);
	Forum([[Error In-Process API Event Argument|Error]] error);
	Forum([[Warning In-Process API Event Argument|Warning]] warning);
	IList<string> AllowedThreadTypes { get; set;  }
	Guid ApplicationId { get; set;  }
	int? AutoLockingDefaultInterval { get; set;  }
	bool? AutoLockingEnabled { get; set;  }
	string AvatarUrl { get;  }
	[[Container In-Process API Event Argument|Container]] Container { get;  }
	Guid ContentId { get;  }
	DateTime? DateCreated { get; set;  }
	string DefaultThreadStatus { get; set;  }
	string DefaultThreadType { get; set;  }
	string Description { get; set;  }
	string EmailAddress { get; set;  }
	string EmailFooter { get; set;  }
	bool Enabled { get; set;  }
	bool EnablePassiveMode { get; set;  }
	bool EnablePostStatistics { get; set;  }
	bool EnableQualityVoting { get; set;  }
	IList<[[Error In-Process API Event Argument|Error]]> Errors { get;  }
	[[ApiList(T) In-Process API Event Argument|ApiList]]<[[ExtendedAttribute In-Process API Event Argument|ExtendedAttribute]]> ExtendedAttributes { get; set;  }
	[[Group In-Process API Event Argument|Group]] Group { get; set;  }
	int? Id { get; set;  }
	bool IndexPosts { get; set;  }
	string Key { get;  }
	DateTime? LatestPostDate { get; set;  }
	string MailingListName { get; set;  }
	bool ModeratePosts { get; set;  }
	string Name { get; set;  }
	string PassiveModeAddress { get; set;  }
	int? PostsToModerate { get; set;  }
	int ReplyCount { get; set;  }
	int SuggestedAnswerVoteThreshold { get; set;  }
	int ThreadCount { get; set;  }
	string Url { get; set;  }
	int VerifiedAnswerVoteThreshold { get; set;  }
	IList<[[Warning In-Process API Event Argument|Warning]]> Warnings { get;  }
	bool HasErrors();
	bool HasWarnings();
	bool HasWarningsOrErrors();
	string HtmlDescription(string target);
	void ThrowErrors();
}

Constructors

Forum(AdditionalInfo additionalInfo);

Parameters

Name	Type	Description	Required	Default	Options
additionalInfo	`[[AdditionalInfo In-Process API Supplementary Type\|AdditionalInfo]]`	Additional Info	Required

Forum(Error error);

Parameters

Name	Type	Description	Required	Default	Options
error	`[[Error In-Process API Event Argument\|Error]]`	Error	Required

Forum(Warning warning);

Parameters

Name	Type	Description	Required	Default	Options
warning	`[[Warning In-Process API Event Argument\|Warning]]`	Warning	Required

Properties

Name	Type	Description
AllowedThreadTypes	`IList<string>`
ApplicationId	`Guid`	A Guid uniquely identifying the application.
AutoLockingDefaultInterval	`int?`
AutoLockingEnabled	`bool?`
AvatarUrl	`string`	This can represent a Url to an image particular to the application or application type.
Container	`[[Container In-Process API Event Argument\|Container]]`
ContentId	`Guid`	A Guid uniquely identifying the content.
DateCreated	`DateTime?`
DefaultThreadStatus	`string`
DefaultThreadType	`string`
Description	`string`
EmailAddress	`string`
EmailFooter	`string`
Enabled	`bool`
EnablePassiveMode	`bool`
EnablePostStatistics	`bool`
EnableQualityVoting	`bool`
Errors	`IList<[[Error In-Process API Event Argument\|Error]]>`
ExtendedAttributes	`[[ApiList(T) In-Process API Event Argument\|ApiList]]<[[ExtendedAttribute In-Process API Event Argument\|ExtendedAttribute]]>`
Group	`[[Group In-Process API Event Argument\|Group]]`
Id	`int?`
IndexPosts	`bool`
Key	`string`
LatestPostDate	`DateTime?`
MailingListName	`string`
ModeratePosts	`bool`
Name	`string`
PassiveModeAddress	`string`
PostsToModerate	`int?`
ReplyCount	`int`
SuggestedAnswerVoteThreshold	`int`
ThreadCount	`int`
Url	`string`	A Url to the application on the site.
VerifiedAnswerVoteThreshold	`int`
Warnings	`IList<[[Warning In-Process API Event Argument\|Warning]]>`

Methods

bool HasErrors();

Return Type

bool

bool HasWarnings();

Return Type

bool

bool HasWarningsOrErrors();

Return Type

bool

string HtmlDescription(string target);

This method should return the Html encoded description of the application. Possible values for “target” are “Web”, “Email”, “WebServices”, or “raw”. When “raw” is specified as the target, the description should not be encoded or have any special rendering done to it. If there is no description, an empty string should be returned.

Parameters

Name	Type	Description	Required	Default	Options
target	`string`	Target	Required

Return Type

string