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<List<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormRecordChatResource>>	allChats(IUserPortalInvocationContext upc, UUID userPortalUuid)	Gets all chats for the current user.
IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormRecordChatResource>	byUuid(IUserPortalInvocationContext ctx, UUID userPortalUuid, UUID chatUuid)	Gets a chat by its UUID.
IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormRecordMessageResource>	getMessageByUuid(IUserPortalInvocationContext ctx, UUID userPortalUuid, UUID chatUuid, UUID messageUuid)	Gets a message by its UUID.
IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormRecordMessageResource>	sendMessage(IUserPortalInvocationContext ctx, String message, UUID userPortalUuid, UUID chatUuid)	Sends a message to a chat.

Method Detail

allChats

IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormRecordChatResource>> allChats(IUserPortalInvocationContext upc,
                                                                                                                      UUID userPortalUuid)

Gets all chats for the current user.

Parameters:

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

userPortalUuid - Portal uuid to download the portal file from.

Returns:

A list of all chats for the current user.

byUuid

IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormRecordChatResource> byUuid(IUserPortalInvocationContext ctx,
                                                                                                              UUID userPortalUuid,
                                                                                                              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.

userPortalUuid - Portal uuid to download the portal file from.

Returns:

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

sendMessage

IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormRecordMessageResource> sendMessage(IUserPortalInvocationContext ctx,
                                                                                                                      String message,
                                                                                                                      UUID userPortalUuid,
                                                                                                                      UUID chatUuid)

Sends a message to a chat.

Parameters:

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

message - The message to send.

userPortalUuid - Portal uuid to download the portal file from.

Returns:

null if the message was sent successfully, an error message otherwise.

getMessageByUuid

IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalFormRecordMessageResource> getMessageByUuid(IUserPortalInvocationContext ctx,
                                                                                                                           UUID userPortalUuid,
                                                                                                                           UUID chatUuid,
                                                                                                                           UUID messageUuid)

Gets a message by its UUID.

Parameters:

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

messageUuid - The UUID of the message to retrieve.

userPortalUuid - Portal uuid to download the portal file from.

Returns:

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