Conversation Script API Type

Ben Tiedt — Fri, 08 Mar 2024 17:25:29 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:25:29

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

Properties
HasErrors
HasWarnings
HasWarningsOrErrors
HtmlDescription
HtmlName
ThrowErrors

Properties

Name	Access	Type	Description
Application	Read	`[[IApplication Script API Type\|IApplication]]`	The application in which the IContent is located.
AvatarUrl	Read	`String`	Url to an image particular to the content or content type. If none, return null.
ContentId	Read	`Guid`	A Guid uniquely identifying the content.
ContentTypeId	Read	`Guid`	A Guid identifying the type of content. All content of the same type (i.e. wiki page) will have the same value here.
CreatedByUserId	Read	`Nullable of Int32`	The Id of the user who originated the content.
CreatedDate	Read	`Nullable of DateTime`	The date the content was created.
CreatedUser	Read	`[[User Script API Type\|User]]`	Created User
Errors	Read	`IList of [[Error Script API Type\|Error]]`	Errors
FirstMessage	Read	`[[ConversationMessage Script API Type\|ConversationMessage]]`	First Message
HasRead	Read	`Boolean`	Has Read
Id	Read	`Nullable of Guid`	Id
IsEnabled	Read	`Boolean`	A flag representing whether the content is enabled. This can be a wrapper for approval states, etc.
LastMessage	Read	`[[ConversationMessage Script API Type\|ConversationMessage]]`	Last Message
MessageCount	Read	`Nullable of Int32`	Message Count
Participants	Read	`IList of [[User Script API Type\|User]]`	Participants
Url	Read	`String`	A Url to the content on the site.
Warnings	Read	`IList of [[Warning Script API Type\|Warning]]`	Warnings

Methods

HasErrors

Velocity

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

JavaScript

var booleanResponse = conversation.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = conversation.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

var booleanResponse = conversation.HasWarningsOrErrors();

Returns

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 = $conversation.HtmlDescription($target))

JavaScript

var stringResponse = conversation.HtmlDescription(target);

Parameters

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

Returns

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 = $conversation.HtmlName($target))

JavaScript

var stringResponse = conversation.HtmlName(target);

Parameters

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

Returns

String

ThrowErrors

Velocity

$conversation.ThrowErrors()

JavaScript

conversation.ThrowErrors();

Returns

Nothing