JavaScript methods - Fluid Topics - Latest

Fluid Topics Designer Guide

Category
Reference Guides
Audience
public
Version
Latest

Fluid Topics offers the following built-in JavaScript methods:

Name Availability Description
FluidTopicsApi() All designers. Allows designers to use the Fluid Topics API in Custom components more easily.
FluidTopicsAuthenticationService.directLogin() All designers. Allows designers to log in a user.
FluidTopicsAuthenticationService.getUser() All designers. Allows designers to get information about the current user.
FluidTopicsAuthenticationService.logout() All designers. Allows designers to log out the current user.
FluidTopicsDateService.format() All designers. Allows designers to format a date according to the format used by Fluid Topics.
FluidTopicsDateService.isDate() All designers. Returns if a specific metadata key is defined as a date.
FluidTopicsGenerativeAIService.generate() All designers. Allows designers to query a Large Language Model (LLM) through Fluid Topics in a Custom component.
FluidTopicsHighlightHtmlService.highlightHtml() All designers. Allows designers to highlight a word.
FluidTopicsLocaleService.getContentLocale() All designers. Returns the current search/content locale as an IETF language tag.
FluidTopicsLocaleService.getUiLocale() All designers. Returns the current UI locale as an IETF language tag.
FluidTopicsLocaleService.setUiLocale() All designers. Allows designers to set the current UI locale.
FluidTopicsLocaleService.setContentLocale() All designers. Allows designers to set the current search/content locale.
FluidTopicsNotificationService.info|warn|error() All designers. Allows designers to notify users of an action.
FluidTopicsReaderService.searchInDocument() All designers. Allows designers to set the user's search in document query.
FluidTopicsRouterService.navigateTo() All designers. Allows designers to redirect users to another page on the same portal.
FluidTopicsThemeService.getActiveTheme() All designers. Provides information about the current active theme for the user.
FluidTopicsThemeService.listThemes() All designers. Provides information about the portal's published themes.
FluidTopicsThemeService.setTheme() All designers. Allows users to set what portal theme to use.
FluidTopicsTranslationService.translate() All designers. Allows designers to perform translations in Custom components.
getContent() Topic template designer Returns the HTML content of the current topic.
getMetadata() Topic template designer Returns the metadata of the current topic.
getRating() Reader designer and Topic template designer Returns information about the rating given to the current map or topic.
loadExternalScript() All designers. Allows designers to load an external script to the <head> section of the portal.
rate() Reader designer and Topic template designer Allows designers to rate a map or topic.
sendFeedback() Reader designer and Topic template designer Allows designers to send feedback about a map or topic.
unrate() Reader designer and Topic template designer Allows designers to unrate a map or topic.