Class Collection.Builder

  • Enclosing class:
    Collection

    public static final class Collection.Builder
    extends java.lang.Object
    • Method Detail

      • id

        public Collection.Builder id​(java.util.Optional<java.lang.String> id)

        The unique identifier for the collection which is given by Intercom.

      • workspaceId

        public Collection.Builder workspaceId​(java.util.Optional<java.lang.String> workspaceId)

        The id of the workspace which the collection belongs to.

      • name

        public Collection.Builder name​(java.util.Optional<java.lang.String> name)

        The name of the collection. For multilingual collections, this will be the name of the default language's content.

      • description

        public Collection.Builder description​(java.util.Optional<java.lang.String> description)

        The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.

      • createdAt

        public Collection.Builder createdAt​(java.util.Optional<java.lang.Integer> createdAt)

        The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.

      • updatedAt

        public Collection.Builder updatedAt​(java.util.Optional<java.lang.Integer> updatedAt)

        The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.

      • url

        public Collection.Builder url​(java.util.Optional<java.lang.String> url)

        The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.

      • icon

        public Collection.Builder icon​(java.util.Optional<java.lang.String> icon)

        The icon of the collection.

      • order

        public Collection.Builder order​(java.util.Optional<java.lang.Integer> order)

        The order of the section in relation to others sections within a collection. Values go from 0 upwards. 0 is the default if there's no order.

      • defaultLocale

        public Collection.Builder defaultLocale​(java.util.Optional<java.lang.String> defaultLocale)

        The default locale of the help center. This field is only returned for multilingual help centers.

      • defaultLocale

        public Collection.Builder defaultLocale​(java.lang.String defaultLocale)
      • parentId

        public Collection.Builder parentId​(java.util.Optional<java.lang.String> parentId)

        The id of the parent collection. If null then it is the first level collection.

      • helpCenterId

        public Collection.Builder helpCenterId​(java.util.Optional<java.lang.Integer> helpCenterId)

        The id of the help center the collection is in.

      • helpCenterId

        public Collection.Builder helpCenterId​(java.lang.Integer helpCenterId)