IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.user_portal.model.BaseAuthenticatorResource>> |
IUsersApi.authenticatorsByPortal(IUserPortalInvocationContext ctx,
UUID portalUuid) |
Retrieves all available authenticators for a user portal.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.DetailedUserPortalResource> |
IPortalsApi.byAlias(IUserPortalInvocationContext ctx,
String portalAlias) |
Gets a user portal by its alias.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.DetailedFormRecordChatResource> |
IChatsApi.byUuid(IUserPortalInvocationContext ctx,
UUID chatUuid) |
Gets a chat by its UUID.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.DetailedFormRecordResource> |
IFormRecordsApi.byUuid(IUserPortalInvocationContext ctx,
UUID formRecordUuid) |
Gets a form record by its UUID.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.DetailedFormResource> |
IFormsApi.byUuid(IUserPortalInvocationContext ctx,
UUID clientUuid,
UUID formUuid) |
Reads a form by its UUID.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.DetailedUserPortalResource> |
IPortalsApi.byUuid(IUserPortalInvocationContext ctx,
UUID portalUuid) |
Gets a user portal by its uuid.
|
IUserPortalResponse<Path> |
IFormRecordAttachmentApi.downloadFormRecordAttachment(IUserPortalInvocationContext ctx,
UUID attachmentUuid) |
Downloads a form record attachment.
|
IUserPortalResponse<Path> |
IUsersApi.downloadProfileImage(IUserPortalInvocationContext ctx) |
Retrieves the profile image of the currently authenticated user.
|
IUserPortalResponse<Path> |
IFilesApi.downloadUserPortalFile(IUserPortalInvocationContext ctx,
UUID portalUuid,
UUID fileUuid) |
Downloads a file from a given portal.
|
IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.form_record.model.BaseFormRecordResource>> |
IFormRecordsApi.getAllFormRecords(IUserPortalInvocationContext ctx,
FormRecordsQueryModel query,
UUID portalUuid) |
Gets all form records for the current user as a participant in a portal.
|
IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.user_portal.model.FormTagResource>> |
IFormsApi.getAllTags(IUserPortalInvocationContext ctx,
UUID userPortalUuid) |
Reads all tags of a given portal.
|
IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.form_record.model.BaseFormRecordMessageResource>> |
IMessagesApi.getChatMessages(IUserPortalInvocationContext ctx,
UUID chatUuid) |
Gets all messages for the current user and chat.
|
IUserPortalResponse<Integer> |
IFormRecordsApi.getFormRecordAsParticipantCount(IUserPortalInvocationContext ctx,
UUID portalUuid) |
Get total count of form records as a participant in a portal.
|
IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.form_record.model.BaseFormRecordAttachmentResource>> |
IFormRecordAttachmentApi.getFormRecordAttachments(IUserPortalInvocationContext ctx,
UUID formRecordUuid) |
Gets all attachments for a form record.
|
IUserPortalResponse<Integer> |
IFormRecordAttachmentApi.getFormRecordAttachmentsCount(IUserPortalInvocationContext ctx,
UUID formRecordUuid) |
Gets the total number of attachments for a form record.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.FormRecordAttachmentResourcePage> |
IFormRecordAttachmentApi.getFormRecordAttachmentsPage(IUserPortalInvocationContext ctx,
PagingDataModel pagingDataModel,
UUID formRecordUuid) |
Gets a paginated list of attachments for a form record.
|
IUserPortalResponse<Integer> |
IChatsApi.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> |
IChatsApi.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> |
IChatsApi.getFormRecordChatsPage(IUserPortalInvocationContext ctx,
UUID formRecordUuid,
PagingDataModel pagingDataModel) |
Gets a page of chats for a form record.
|
IUserPortalResponse<Integer> |
IFormRecordsApi.getFormRecordsCount(IUserPortalInvocationContext ctx,
FormRecordsQueryModel query,
UUID portalUuid) |
Get total count of form records.
|
IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.form_record.model.StateHistoryEntry>> |
IFormRecordsApi.getFormRecordsHistory(IUserPortalInvocationContext ctx,
UUID formRecordUuid) |
Get form records history.
|
IUserPortalResponse<Integer> |
IFormRecordsApi.getFormRecordsHistoryCount(IUserPortalInvocationContext ctx,
UUID formRecordUuid) |
Get the form records history count.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.FormRecordStateHistoryEntryResourcePage> |
IFormRecordsApi.getFormRecordsHistoryPage(IUserPortalInvocationContext ctx,
PagingDataModel pagingDataModel,
UUID portalUuid) |
Gets all form records for the current user.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.FormRecordResourcePage> |
IFormRecordsApi.getFormRecordsPage(IUserPortalInvocationContext ctx,
PagingDataModel pagingDataModel,
FormRecordsQueryModel query,
UUID portalUuid) |
Gets all form records for the current user.
|
IUserPortalResponse<Integer> |
IFormsApi.getFormsCount(IUserPortalInvocationContext ctx,
UUID userPortalUuid,
FormsQueryModel queryModel) |
Reads the count of forms of a given portal.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.FormResourcePage> |
IFormsApi.getFormsPage(IUserPortalInvocationContext ctx,
UUID userPortalUuid,
PagingDataModel pagingDataModel,
FormsQueryModel queryModel) |
Reads a page of forms of a given portal.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.FormRecordMessageResourcePage> |
IMessagesApi.getMessages(IUserPortalInvocationContext ctx,
PagingDataModel pagingDataModel,
MessagesQueryModel queryModel) |
Gets all messages for the current user.
|
IUserPortalResponse<Integer> |
IMessagesApi.getMessagesCount(IUserPortalInvocationContext ctx,
MessagesQueryModel queryModel) |
Gets the number of messages for the current user.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.security.model.MfaSettingsResponse> |
IUsersApi.getMfaSettings(IUserPortalInvocationContext ctx) |
Retrieves the multi-factor authentication (MFA) settings.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.user.model.DetailedUserProfileResource> |
IUsersApi.getProfile(IUserPortalInvocationContext ctx) |
Retrieves the profile of the currently authenticated user.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.security.model.AuthenticationTokenResponse> |
IUsersApi.login(IUserPortalInvocationContext ctx,
de.xima.fc.api.rest.pub.client.user_portal.model.BaseAuthenticatorResource client,
String username,
String password) |
Authenticates a user and returns the user.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.security.model.AuthenticationTokenResponse> |
IUsersApi.login(IUserPortalInvocationContext ctx,
String clientName,
String username,
String password) |
Authenticates a user and returns the user.
|
IUserPortalResponse<Void> |
IChatsApi.markRead(IUserPortalInvocationContext ctx,
UUID chatUuid) |
Marks a chat as read.
|
IUserPortalResponse<Void> |
IFormRecordsApi.markRead(IUserPortalInvocationContext ctx,
UUID recordUuid) |
Marks a form record as read.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.security.model.MfaTempTokenResponse> |
IUsersApi.sendEmailCode(IUserPortalInvocationContext ctx,
String token) |
Sends an email with a code for multi-factor authentication (MFA) to the user.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.DetailedFormRecordMessageResource> |
IMessagesApi.sendMessage(IUserPortalInvocationContext ctx,
String message,
UUID chatUuid) |
Sends a message to a chat.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.form_record.model.DetailedFormRecordMessageUploadRequestResource> |
IMessagesApi.uploadAttachment(IUserPortalInvocationContext ctx,
UUID messageUuid,
UUID uploadRequestUuid,
List<File> files) |
Uploads an attachment to a message.
|
IUserPortalResponse<de.xima.fc.api.rest.pub.client.security.model.MfaVerificationResponse> |
IUsersApi.verifyMfa(IUserPortalInvocationContext ctx,
String code,
String token,
boolean saveMfaOption) |
Verifies a multi-factor authentication (MFA) code for the currently authenticated user.
|