Package de.xima.fc.user_portal.api.provider.spec

Interface IChatsApi

public interface IChatsApi

High-level methods for interacting with portal chats and messages.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.DetailedFormRecordChatResource>	byUuid(IUserPortalInvocationContext ctx, UUID chatUuid)	Gets a chat by its UUID.
IUserPortalResponse<Integer>	getFormRecordChatMessagesCount(IUserPortalInvocationContext ctx, UUID chatUuid, MessagesQueryModel queryModel)	Gets the total number of messages in a chat.
IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.FormRecordMessageResourcePage>	getFormRecordChatMessagesPage(IUserPortalInvocationContext ctx, UUID chatUuid, PagingDataModel pagingDataModel, MessagesQueryModel queryModel)	Gets a page of chat messages for a specific chat.
IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.FormRecordChatResourcePage>	getFormRecordChatsPage(IUserPortalInvocationContext ctx, UUID formRecordUuid, PagingDataModel pagingDataModel)	Gets a page of chats for a form record.
IUserPortalResponse<Void>	markRead(IUserPortalInvocationContext ctx, UUID chatUuid)	Marks a chat as read.

Method Detail

byUuid

IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.DetailedFormRecordChatResource> byUuid(IUserPortalInvocationContext ctx,
                                                                                                            UUID chatUuid)

Gets a chat by its UUID.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

chatUuid - The UUID of the chat to retrieve.

Returns:

The chat with the given UUID, null if no such chat exists.

markRead

IUserPortalResponse<Void> markRead(IUserPortalInvocationContext ctx,
                                   UUID chatUuid)

Marks a chat as read.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

chatUuid - The UUID of the chat to mark as read.

Returns:

null if the chat was marked as read successfully, an error message otherwise.

getFormRecordChatsPage

IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.FormRecordChatResourcePage> getFormRecordChatsPage(IUserPortalInvocationContext ctx,
                                                                                                                        UUID formRecordUuid,
                                                                                                                        PagingDataModel pagingDataModel)

Gets a page of chats for a form record.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

formRecordUuid - The UUID of the form record to retrieve chats for.

pagingDataModel - Paging data for the chats to retrieve.

Returns:

A list of chats for the form record.

getFormRecordChatMessagesPage

IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.FormRecordMessageResourcePage> getFormRecordChatMessagesPage(IUserPortalInvocationContext ctx,
                                                                                                                                  UUID chatUuid,
                                                                                                                                  PagingDataModel pagingDataModel,
                                                                                                                                  MessagesQueryModel queryModel)

Gets a page of chat messages for a specific chat.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

chatUuid - The UUID of the chat to retrieve messages for.

pagingDataModel - Paging data model for pagination.

Returns:

A paginated list of chat messages for the specified chat.

getFormRecordChatMessagesCount

IUserPortalResponse<Integer> getFormRecordChatMessagesCount(IUserPortalInvocationContext ctx,
                                                            UUID chatUuid,
                                                            MessagesQueryModel queryModel)

Gets the total number of messages in a chat.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

chatUuid - The UUID of the chat to count messages for.

Returns:

The total number of messages in the chat.