ConversationMessages In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:03:17 GMT

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

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IConversationMessages>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void ConversationMessageAfterCreateEventHandler([[ConversationMessageAfterCreateEventArgs In-Process API Event Argument|ConversationMessageAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void ConversationMessageAfterDeleteEventHandler([[ConversationMessageAfterDeleteEventArgs In-Process API Event Argument|ConversationMessageAfterDeleteEventArgs]] e);

Events.BeforeCreate

Handler

void ConversationMessageBeforeCreateEventHandler([[ConversationMessageBeforeCreateEventArgs In-Process API Event Argument|ConversationMessageBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void ConversationMessageBeforeDeleteEventHandler([[ConversationMessageBeforeDeleteEventArgs In-Process API Event Argument|ConversationMessageBeforeDeleteEventArgs]] e);

Events.Render

Handler

void ConversationMessageRenderEventHandler([[ConversationMessageRenderEventArgs In-Process API Event Argument|ConversationMessageRenderEventArgs]] e);

Properties

Name	Type	Description	Default	Options
ContentTypeId	`Guid`	Conversation message content type
DataTypeId	`Guid`	Conversation message data type identifier

Methods

ConversationMessage Create(Guid conversationId, string body, ConversationMessagesCreateOptions options = null);

Creates a new conversation

Parameters

Name	Type	Description	Required
conversationId	`Guid`	Id of the conversation	Required
body	`string`	Body of the conversation	Required
options	`[[ConversationMessagesCreateOptions In-Process API Supplementary Type\|ConversationMessagesCreateOptions]]`	Optional parameter names are: Subject, ReadUsers. Note: Subject is OBSOLETE in v10.0 and will not be saved.	Optional

Return Type

[[ConversationMessage In-Process API Supplementary Type|ConversationMessage]]

AdditionalInfo Delete(Guid conversationId, Guid id);

Delete a conversation message

Parameters

Name	Type	Description	Required	Default	Options
conversationId	`Guid`	Id of the parent conversation	Required
id	`Guid`	Id of the conversation message	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

ConversationMessage Get(Guid messageId);

Gets a conversation by Id

Parameters

Name	Type	Description	Required	Default	Options
messageId	`Guid`	Message Id	Required

Return Type

[[ConversationMessage In-Process API Supplementary Type|ConversationMessage]]

PagedList<ConversationMessage> List(Guid conversationId, ConversationMessagesListOptions options = null);

List conversation messages for a conversation

Parameters

Name	Type	Description	Required	Default	Options
conversationId	`Guid`	Id of a conversation	Required
options	`[[ConversationMessagesListOptions In-Process API Supplementary Type\|ConversationMessagesListOptions]]`	Optional parameter names are: PageSize, PageIndex, SortOrder	Optional

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[ConversationMessage In-Process API Supplementary Type|ConversationMessage]]>

PagedList<ConversationMessage> Search(ConversationMessagesSearchOptions options);

Search for conversation messages

Parameters

Name	Type	Description	Required	Default	Options
options	`[[ConversationMessagesSearchOptions In-Process API Supplementary Type\|ConversationMessagesSearchOptions]]`	Optional parameter names are: PageSize, PageIndex, SortBy, SortOrder	Required

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[ConversationMessage In-Process API Supplementary Type|ConversationMessage]]>