Package com.commercetools.api.models.message

Interface MessagesConfiguration

All Known Subinterfaces:
MessageConfiguration
public interface MessagesConfiguration

Holds the configuration for the Messages Query feature for the Project.

Example to create an instance using the builder pattern 

     MessagesConfiguration messagesConfiguration = MessagesConfiguration.builder()
             .enabled(true)
             .build()

  • Method Details

    • getEnabled

      @NotNull @NotNull Boolean getEnabled()

      When true, the Messages Query feature is active.

      Returns:
      enabled

    • getDeleteDaysAfterCreation

      Integer getDeleteDaysAfterCreation()

      Specifies the number of days each Message should be available via the Messages Query API. For Messages older than the specified period, it is not guaranteed that they are still accessible via the API. This field may not be present on Projects created before 8 October 2018.

      Returns:
      deleteDaysAfterCreation

    • setEnabled

      void setEnabled(Boolean enabled)

      When true, the Messages Query feature is active.

      Parameters:
      enabled - value to be set

    • setDeleteDaysAfterCreation

      void setDeleteDaysAfterCreation(Integer deleteDaysAfterCreation)

      Specifies the number of days each Message should be available via the Messages Query API. For Messages older than the specified period, it is not guaranteed that they are still accessible via the API. This field may not be present on Projects created before 8 October 2018.

      Parameters:
      deleteDaysAfterCreation - value to be set

    • of

      static MessagesConfiguration of()
      factory method
      Returns:
      instance of MessagesConfiguration

    • of

      static MessagesConfiguration of(MessagesConfiguration template)
      factory method to create a shallow copy MessagesConfiguration
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static MessagesConfiguration deepCopy(@Nullable MessagesConfiguration template)
      factory method to create a deep copy of MessagesConfiguration
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static MessagesConfigurationBuilder builder()
      builder factory method for MessagesConfiguration
      Returns:
      builder

    • builder

      static MessagesConfigurationBuilder builder(MessagesConfiguration template)
      create builder for MessagesConfiguration instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withMessagesConfiguration

      default <T> T withMessagesConfiguration(Function<MessagesConfiguration,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<MessagesConfiguration> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference