Conversation In-Process API Supplementary Type

Ben Tiedt — Tue, 19 Nov 2019 20:07:35 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:07:35

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

Conversation is defined in the Telligent.Evolution.Extensibility.Api.Entities.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

class Conversation
{
	[[IApplication In-Process API Supplementary Type|IApplication]] Application { get;  }
	string AvatarUrl { get;  }
	Guid ContentId { get;  }
	Guid ContentTypeId { get;  }
	int? CreatedByUserId { get;  }
	DateTime? CreatedDate { get;  }
	[[User In-Process API Supplementary Type|User]] CreatedUser { get;  }
	[[ConversationMessage In-Process API Supplementary Type|ConversationMessage]] FirstMessage { get;  }
	bool HasRead { get;  }
	Guid? Id { get;  }
	bool IsEnabled { get;  }
	[[ConversationMessage In-Process API Supplementary Type|ConversationMessage]] LastMessage { get;  }
	int? MessageCount { get;  }
	IList<[[User In-Process API Supplementary Type|User]]> Participants { get;  }
	string Url { get; set;  }
	string HtmlDescription(string target);
	string HtmlName(string target);
}

Properties

Name	Type	Description
Application	`[[IApplication In-Process API Supplementary Type\|IApplication]]`	The application in which the IContent is located.
AvatarUrl	`string`	Url to an image particular to the content or content type. If none, return null.
ContentId	`Guid`	A Guid uniquely identifying the content.
ContentTypeId	`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	`int?`	The Id of the user who originated the content.
CreatedDate	`DateTime?`
CreatedUser	`[[User In-Process API Supplementary Type\|User]]`
FirstMessage	`[[ConversationMessage In-Process API Supplementary Type\|ConversationMessage]]`
HasRead	`bool`
Id	`Guid?`
IsEnabled	`bool`	A flag representing whether the content is enabled. This can be a wrapper for approval states, etc.
LastMessage	`[[ConversationMessage In-Process API Supplementary Type\|ConversationMessage]]`
MessageCount	`int?`
Participants	`IList<[[User In-Process API Supplementary Type\|User]]>`
Url	`string`	A Url to the content on the site.

Methods

string HtmlDescription(string target);

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.

Parameters

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

Return Type

string

string HtmlName(string target);

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.

Parameters

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

Return Type

string