Class FormRecordChatAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<FormRecordChat>

de.xima.fc.api.entity.FormRecordChatAPI

public class FormRecordChatAPI
extends AEntityAPI<FormRecordChat>

API class for reading and writing FormRecordChat entities.

Since:

8.2.0

Author:

XIMA Media GmbH

Field Summary

Fields inherited from class AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor	Description
FormRecordChatAPI()

Method Summary

Modifier and Type	Method	Description
List<FormRecordChat>	getAllByRecord(UserContext uc, String recordUuid)
PagedResult<BaseFormRecordChatDTO>	getByRecordAndUser(UserContext uc, UUID recordUuid, IUser user, int page, int pageSize, Locale locale)
List<FormRecordChat>	getByUser(UserContext uc, IUser user)
PagedResult<FormRecordChat>	getByUser(UserContext uc, IUser user, int page, int pageSize, int offset)
FormRecordChat	getByUuid(UserContext uc, UUID uuid)
FormRecordChat	getByUuidAndUser(UserContext uc, UUID uuid, IUser user)
DetailedFormRecordChatDTO	getDetailsByUuidAndUser(UserContext uc, UUID uuid, IUser user, Locale locale)
PagedResult<BaseFormRecordChatDTO>	getFormRecordChatsPage(UserContext uc, PageQuery page, FormRecordChatsQuery query, boolean skipCount)
void	markReadByEndUser(@NotNull UserContext uc, @NotNull UUID chatUuid, @NotNull IUser user)
void	markReadByInboxUser(UserContext uc, UUID chatUuid, IUser user)

Methods inherited from class AEntityAPI

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getPagedResult, getSingleAttributes, getSingleAttributes, resultTotalCount, resultTotalCount, update, update

Methods inherited from class ASubAPI

getHandlerProvider

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FormRecordChatAPI

public FormRecordChatAPI()

Method Details

getAllByRecord

public List<FormRecordChat> getAllByRecord(UserContext uc,
 String recordUuid)

See Also:

• IFormRecordChatHandler.getAllByRecord(UserContext, String)

getByRecordAndUser

public PagedResult<BaseFormRecordChatDTO> getByRecordAndUser(UserContext uc,
 UUID recordUuid,
 IUser user,
 int page,
 int pageSize,
 Locale locale)

See Also:

• IFormRecordChatHandler.getByRecordAndUser(UserContext, UUID, IUser, int, int, Locale)

getByUser

public List<FormRecordChat> getByUser(UserContext uc,
 IUser user)

See Also:

• IFormRecordChatHandler.getByUser(UserContext, IUser)

getByUser

public PagedResult<FormRecordChat> getByUser(UserContext uc,
 IUser user,
 int page,
 int pageSize,
 int offset)

See Also:

• IFormRecordChatHandler.getByUser(UserContext, IUser, int, int, int)

getByUuid

public FormRecordChat getByUuid(UserContext uc,
 UUID uuid)

See Also:

• IFormRecordChatHandler.getByUuid(UserContext, UUID)

getByUuidAndUser

public FormRecordChat getByUuidAndUser(UserContext uc,
 UUID uuid,
 IUser user)

See Also:

• IFormRecordChatHandler.getByUuidAndUser(UserContext, UUID, IUser)

getDetailsByUuidAndUser

public DetailedFormRecordChatDTO getDetailsByUuidAndUser(UserContext uc,
 UUID uuid,
 IUser user,
 Locale locale)

See Also:

• IFormRecordChatHandler.getDetailsByUuidAndUser(UserContext, UUID, IUser, Locale)

getFormRecordChatsPage

public PagedResult<BaseFormRecordChatDTO> getFormRecordChatsPage(UserContext uc,
 PageQuery page,
 FormRecordChatsQuery query,
 boolean skipCount)

Since:

8.4.0

See Also:

• IFormRecordChatHandler.getFormRecordChatsPage(UserContext, PageQuery, FormRecordChatsQuery, boolean)

markReadByEndUser

public void markReadByEndUser(@NotNull
 @NotNull UserContext uc,
 @NotNull
 @NotNull UUID chatUuid,
 @NotNull
 @NotNull IUser user)

Since:

8.4.0

See Also:

• IFormRecordChatHandler.markReadByEndUser(UserContext, UUID, IUser)

markReadByInboxUser

public void markReadByInboxUser(UserContext uc,
 UUID chatUuid,
 IUser user)

Since:

8.4.0

See Also:

• IFormRecordChatHandler.markReadByInboxUser(UserContext, UUID, IUser)