Package org.exoplatform.agenda.service

Interface AgendaUserSettingsService

public interface AgendaUserSettingsService

  • Method Details

    • saveAgendaUserSettings

      void saveAgendaUserSettings(long identityId, AgendaUserSettings agendaUserSettings)
      Save user agenda settings to use in events by default
      Parameters:
      identityId - technical identifier of Identity
      agendaUserSettings - object of AgendaUserSettings

    • getAgendaUserSettings

      AgendaUserSettings getAgendaUserSettings(long identityId)
      Get list of user settings to use in events by default
      Parameters:
      identityId - technical identifier of Identity
      Returns:
      AgendaUserSettings

    • saveUserConnector

      void saveUserConnector(String connectorName, String connectorUserId, long userIdentityId)
      Saves the new connected user settings on remote events provider
      Parameters:
      connectorName - connector identifier
      connectorUserId - user identifier on remote provider
      userIdentityId - user social identifier

    • getDefaultReminders

      List<EventReminderParameter> getDefaultReminders()
      Returns:
      List of EventReminderParameter that will be used for users who didn't changed default settings about preferred reminders

    • updateUserTimeZone

      void updateUserTimeZone(String userName, String timeZone) throws org.exoplatform.commons.exception.ObjectNotFoundException
      Update the user TimeZONE
      Parameters:
      userName - userName
      timeZone - timeZone
      Throws:
      org.exoplatform.commons.exception.ObjectNotFoundException - when user profile is not found

    • getEmbedMapProvider

      String getEmbedMapProvider()
      Retrieves the globally configured embed map provider identifier. This setting is shared across all users of the platform.
      Returns:
      the provider id (e.g. "google-maps" or "openStreet-map"), or null if no provider has been explicitly configured

    • saveEmbedMapProvider

      void saveEmbedMapProvider(String providerId)
      Saves the globally configured embed map provider identifier. This setting is shared across all users of the platform.
      Parameters:
      providerId - the identifier of the map provider to use, must not be blank
      Throws:
      IllegalArgumentException - if providerId is blank

    • removeEmbedMapProvider

      void removeEmbedMapProvider()
      Removes the globally configured embed map provider setting. After this call, getEmbedMapProvider() will return null.