This service is available via Telligent.Evolution.Extensibility.Api.Version1.PublicApi.Conversations or Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IConversations>() and is defined in Telligent.Evolution.Api.dll
Events
Events.AfterRead
Handler
void ConversationAfterReadEventHandler(ConversationAfterReadEventArgs e);
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| ContentTypeId | Guid | Content type identifier for conversations |
Methods
int Count(string readStatus);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| readStatus | string | Read status | Required | NotSet, Read, Unread |
Return Type
int
Conversation Create(string subject, string body, string usernames, IList<int> readParticipants);
Creates a new conversation
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| subject | string | Subject of the conversatioin's first message | Required | ||
| body | string | Body of the conversation's first message | Required | ||
| usernames | string | One or more usernames to include in the conversation (comma separated). | Required | ||
| readParticipants | IList<int> | Read participants | Required |
Return Type
Conversation Create(string subject, string body, string usernames);
Creates a new conversation
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| subject | string | Subject of the conversatioin's first message | Required | ||
| body | string | Body of the conversation's first message | Required | ||
| usernames | string | One or more usernames to include in the conversation (comma separated). | Required |
Return Type
AdditionalInfo Delete(Guid id);
Delete a conversation
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | Guid | Id conversation to delete | Required |
Return Type
Conversation Get(Guid conversationId);
Gets a conversation
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| conversationId | Guid | Id of conversation | Required |
Return Type
PagedList<Conversation> List(ConversationsListOptions options = null);
List conversations
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | ConversationsListOptions | Optional parameter names are: ReadStatus, PageSize, PageIndex. If left unspecified, ReadStatus defaults to NotSet. | Optional |
Return Type
void MarkAsRead(Guid id, bool hasRead);
Mark a conversation as Read or Unread
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | Guid | Id conversation to mark as read | Required | ||
| hasRead | bool | Read or Unread | Required |