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.
Definition
class Conversation : ApiEntity, IApiEntity, IContent { Conversation(); Conversation(IGroupService groupService); Conversation(AdditionalInfo additionalInfo); Conversation(Error error); Conversation(Warning warning); Conversation(Conversation item, IMapper<User,User> userMapper); Conversation(IList<Warning> warnings, IList<Error> errors); IApplication Application { get; } string AvatarUrl { get; } Guid ContentId { get; } Guid ContentTypeId { get; } int? CreatedByUserId { get; } DateTime? CreatedDate { get; } User CreatedUser { get; } IList<Error> Errors { get; } ConversationMessage FirstMessage { get; } bool HasRead { get; } Guid? Id { get; } bool IsEnabled { get; } ConversationMessage LastMessage { get; } int? MessageCount { get; } IList<User> Participants { get; } string Url { get; set; } IList<Warning> Warnings { get; } bool HasErrors(); bool HasWarnings(); bool HasWarningsOrErrors(); string HtmlDescription(string target); string HtmlName(string target); void ThrowErrors(); }
Constructors
Conversation();
Conversation(IGroupService groupService);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupService | IGroupService | Group Service | Required |
Conversation(AdditionalInfo additionalInfo);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| additionalInfo | AdditionalInfo | Additional Info | Required |
Conversation(Error error);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| error | Error | Error | Required |
Conversation(Warning warning);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| warning | Warning | Warning | Required |
Conversation(Conversation item, IMapper<User,User> userMapper);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| item | Conversation | Item | Required | ||
| userMapper | IMapper<User,User> | User Mapper | Required |
Conversation(IList<Warning> warnings, IList<Error> errors);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| warnings | IList<Warning> | Warnings | Required | ||
| errors | IList<Error> | Errors | Required |
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| Application | 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 | |||
| Errors | IList<Error> | |||
| FirstMessage | 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 | |||
| MessageCount | int? | |||
| Participants | IList<User> | |||
| Url | string | A Url to the content on the site. | ||
| Warnings | IList<Warning> |
Methods
bool HasErrors();
Return Type
bool HasWarnings();
Return Type
bool HasWarningsOrErrors();
Return Type
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 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 |