Class ArticleListItem.Builder

  • Enclosing class:
    ArticleListItem

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

      • type

        public ArticleListItem.Builder type​(java.util.Optional<java.lang.String> type)

        The type of object - article.

      • id

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

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

      • workspaceId

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

        The id of the workspace which the article belongs to.

      • title

        public ArticleListItem.Builder title​(java.util.Optional<java.lang.String> title)

        The title of the article. For multilingual articles, this will be the title of the default language's content.

      • description

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

        The description of the article. For multilingual articles, this will be the description of the default language's content.

      • body

        public ArticleListItem.Builder body​(java.util.Optional<java.lang.String> body)

        The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.

      • authorId

        public ArticleListItem.Builder authorId​(java.util.Optional<java.lang.Integer> authorId)

        The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

      • state

        public ArticleListItem.Builder state​(java.util.Optional<ArticleListItem.State> state)

        Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.

      • createdAt

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

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

      • updatedAt

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

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

      • url

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

        The URL of the article. For multilingual articles, this will be the URL of the default language's content.

      • parentId

        public ArticleListItem.Builder parentId​(java.util.Optional<java.lang.Integer> parentId)

        The id of the article's parent collection or section. An article without this field stands alone.

      • parentIds

        public ArticleListItem.Builder parentIds​(java.util.Optional<java.util.List<java.lang.Integer>> parentIds)

        The ids of the article's parent collections or sections. An article without this field stands alone.

      • parentType

        public ArticleListItem.Builder parentType​(java.util.Optional<java.lang.String> parentType)

        The type of parent, which can either be a collection or section.

      • defaultLocale

        public ArticleListItem.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.