ConversationMessage Script API Type

Verint | Telligent Community — Wed, 14 May 2025 17:03:44 GMT

Current Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 17:03:44

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

Properties

Name	Access	Type	Description
Application	Read	`[[IApplication Script API Type\|IApplication]]`	The application in which the IContent is located.
Author	Read	`[[User Script API Type\|User]]`	Author
AvatarUrl	Read	`[[String Script API Type\|String]]`	Url to an image particular to the content or content type. If none, return null.
Body	Read	`[[String Script API Type\|String]]`	Body
ContentId	Read	`[[Guid Script API Type\|Guid]]`	A Guid uniquely identifying the content.
ContentTypeId	Read	`[[Guid Script API Type\|Guid]]`	A Guid identifying the type of content. All content of the same type (i.e. wiki page) will have the same value here.
Conversation	Read	`[[Conversation Script API Type\|Conversation]]`	Conversation
ConversationId	Read	`[[Nullable Script API Type\|Nullable]] of [[Guid Script API Type\|Guid]]`	Conversation Id
CreatedByUserId	Read	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	The Id of the user who originated the content.
CreatedDate	Read	`[[Nullable Script API Type\|Nullable]] of [[DateTime Script API Type\|DateTime]]`	The date the content was created.
Errors	Read	`[[List Script API Type\|List]] of [[Error Script API Type\|Error]]`	Errors
Id	Read	`[[Nullable Script API Type\|Nullable]] of [[Guid Script API Type\|Guid]]`	Id
IsEnabled	Read	`[[Boolean Script API Type\|Boolean]]`	A flag representing whether the content is enabled. This can be a wrapper for approval states, etc.
RenderedBody	Read	`[[String Script API Type\|String]]`	Rendered Body
Subject	Read	`[[String Script API Type\|String]]`	Obsolete. Obsolete in 11 Obsolete in 11. Subject
Url	Read	`[[String Script API Type\|String]]`	A Url to the content on the site.
Warnings	Read	`[[List Script API Type\|List]] of [[Warning Script API Type\|Warning]]`	Warnings

Methods

HasErrors

Velocity

#set($booleanResponse = $conversationMessage.HasErrors())

JavaScript

var booleanResponse = conversationMessage.HasErrors();

Returns

[[Boolean Script API Type|Boolean]]

HasWarnings

Velocity

#set($booleanResponse = $conversationMessage.HasWarnings())

JavaScript

var booleanResponse = conversationMessage.HasWarnings();

Returns

[[Boolean Script API Type|Boolean]]

HasWarningsOrErrors

Velocity

#set($booleanResponse = $conversationMessage.HasWarningsOrErrors())

JavaScript

var booleanResponse = conversationMessage.HasWarningsOrErrors();

Returns

[[Boolean Script API Type|Boolean]]

HtmlDescription

Return the Html encoded description of the content (the body, for example). 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.

Velocity

#set($stringResponse = $conversationMessage.HtmlDescription($target))

JavaScript

var stringResponse = conversationMessage.HtmlDescription(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`[[String Script API Type\|String]]`	Target	Required

Returns

[[String Script API Type|String]]

HtmlName

Return the Html encoded name of the content (the subject for example). Possible values for “target” are “Web”, “Email”, or “raw”. When “raw” is specified as the target, the name should not be encoded.

Velocity

#set($stringResponse = $conversationMessage.HtmlName($target))

JavaScript

var stringResponse = conversationMessage.HtmlName(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`[[String Script API Type\|String]]`	Target	Required

Returns

[[String Script API Type|String]]

ThrowErrors

Velocity

$conversationMessage.ThrowErrors()

JavaScript

conversationMessage.ThrowErrors();

Returns

Nothing

ToString

Velocity

#set($stringResponse = $conversationMessage.ToString())

JavaScript

var stringResponse = conversationMessage.ToString();

Returns

[[String Script API Type|String]]