Class Article.Builder

    • Method Detail

      • id

        public Article.WorkspaceIdStage id​(@NotNull
                                           java.lang.String id)

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

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

        Specified by:
        id in interface Article.IdStage
        Returns:
        Reference to this so that method calls can be chained together.
      • workspaceId

        public Article.TitleStage workspaceId​(@NotNull
                                              java.lang.String workspaceId)

        The id of the workspace which the article belongs to.

        The id of the workspace which the article belongs to.

        Specified by:
        workspaceId in interface Article.WorkspaceIdStage
        Returns:
        Reference to this so that method calls can be chained together.
      • title

        public Article.AuthorIdStage title​(@NotNull
                                           java.lang.String title)

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

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

        Specified by:
        title in interface Article.TitleStage
        Returns:
        Reference to this so that method calls can be chained together.
      • authorId

        public Article.StateStage authorId​(int 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.

        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.

        Specified by:
        authorId in interface Article.AuthorIdStage
        Returns:
        Reference to this so that method calls can be chained together.
      • state

        public Article.CreatedAtStage state​(@NotNull
                                            Article.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.

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

        Specified by:
        state in interface Article.StateStage
        Returns:
        Reference to this so that method calls can be chained together.
      • createdAt

        public Article.UpdatedAtStage createdAt​(int 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.

        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.

        Specified by:
        createdAt in interface Article.CreatedAtStage
        Returns:
        Reference to this so that method calls can be chained together.
      • updatedAt

        public Article._FinalStage updatedAt​(int 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.

        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.

        Specified by:
        updatedAt in interface Article.UpdatedAtStage
        Returns:
        Reference to this so that method calls can be chained together.
      • defaultLocale

        public Article._FinalStage defaultLocale​(java.lang.String defaultLocale)

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

        Specified by:
        defaultLocale in interface Article._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.
      • defaultLocale

        public Article._FinalStage defaultLocale​(java.util.Optional<java.lang.String> defaultLocale)

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

        Specified by:
        defaultLocale in interface Article._FinalStage
      • parentType

        public Article._FinalStage parentType​(java.lang.String parentType)

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

        Specified by:
        parentType in interface Article._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.
      • parentIds

        public Article._FinalStage parentIds​(java.util.List<java.lang.Integer> parentIds)

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

        Specified by:
        parentIds in interface Article._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.
      • parentIds

        public Article._FinalStage 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.

        Specified by:
        parentIds in interface Article._FinalStage
      • parentId

        public Article._FinalStage parentId​(java.lang.Integer parentId)

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

        Specified by:
        parentId in interface Article._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.
      • parentId

        public Article._FinalStage 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.

        Specified by:
        parentId in interface Article._FinalStage
      • url

        public Article._FinalStage url​(java.lang.String url)

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

        Specified by:
        url in interface Article._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.
      • url

        public Article._FinalStage 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.

        Specified by:
        url in interface Article._FinalStage
      • body

        public Article._FinalStage body​(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.

        Specified by:
        body in interface Article._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.
      • body

        public Article._FinalStage 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.

        Specified by:
        body in interface Article._FinalStage
      • description

        public Article._FinalStage description​(java.lang.String description)

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

        Specified by:
        description in interface Article._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.
      • description

        public Article._FinalStage 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.

        Specified by:
        description in interface Article._FinalStage
      • type

        public Article._FinalStage type​(java.lang.String type)

        The type of object - article.

        Specified by:
        type in interface Article._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.