Class CreateArticleRequest


  • public final class CreateArticleRequest
    extends java.lang.Object
    • Method Detail

      • getTitle

        public java.lang.String getTitle()
        Returns:
        The title of the article.For multilingual articles, this will be the title of the default language's content.
      • getDescription

        public java.util.Optional<java.lang.String> getDescription()
        Returns:
        The description of the article. For multilingual articles, this will be the description of the default language's content.
      • getBody

        public java.util.Optional<java.lang.String> getBody()
        Returns:
        The content of the article. For multilingual articles, this will be the body of the default language's content.
      • getAuthorId

        public int getAuthorId()
        Returns:
        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.
      • getState

        public java.util.Optional<CreateArticleRequest.State> getState()
        Returns:
        Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language's content.
      • getParentId

        public java.util.Optional<java.lang.Integer> getParentId()
        Returns:
        The id of the article's parent collection or section. An article without this field stands alone.
      • getParentType

        public java.util.Optional<java.lang.String> getParentType()
        Returns:
        The type of parent, which can either be a collection or section.
      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object
      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object