Package io.github.primelib.confluence4j.rest.v1.spec

Klasse GetContentOperationSpec.GetContentOperationSpecBuilder

java.lang.Object
io.github.primelib.confluence4j.rest.v1.spec.GetContentOperationSpec.GetContentOperationSpecBuilder
Umschließende Klasse:
GetContentOperationSpec
public static class GetContentOperationSpec.GetContentOperationSpecBuilder extends Object

  • Methodendetails

    • type

      public GetContentOperationSpec.GetContentOperationSpecBuilder type(@Nullable @Nullable String type)
      The type of content to return. For example: - page - blogpost
      Gibt zurück:
      this.

    • spaceKey

      public GetContentOperationSpec.GetContentOperationSpecBuilder spaceKey(@Nullable @Nullable String spaceKey)
      The key of the space to be queried for its content.
      Gibt zurück:
      this.

    • title

      public GetContentOperationSpec.GetContentOperationSpecBuilder title(@Nullable @Nullable String title)
      The title of the page to be returned. Required for <code>page</code> type.
      Gibt zurück:
      this.

    • status

      public GetContentOperationSpec.GetContentOperationSpecBuilder status(@Nullable @Nullable List<String> status)
      Filter the results to a set of content based on their status. If set to any, content with any status is returned. Note, the historical status is currently not supported.
      Gibt zurück:
      this.

    • postingDay

      public GetContentOperationSpec.GetContentOperationSpecBuilder postingDay(@Nullable @Nullable String postingDay)
      The posting date of the blog post to be returned. Required for &lt;code&gt;blogpost&lt;/code&gt; type. Format: &lt;code&gt;yyyy-mm-dd&lt;/code&gt;.
      Gibt zurück:
      this.

    • expand

      public GetContentOperationSpec.GetContentOperationSpecBuilder expand(@Nullable @Nullable List<String> expand)
      A multi-value parameter indicating which properties of the content to expand. Maximum sub-expansions allowed is 8. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment.
      Gibt zurück:
      this.

    • trigger

      public GetContentOperationSpec.GetContentOperationSpecBuilder trigger(@Nullable @Nullable String trigger)
      If set to viewed, the request will trigger a 'viewed' event for the content. When this event is triggered, the page/blogpost will appear on the 'Recently visited' tab of the user's Confluence dashboard.
      Gibt zurück:
      this.

    • orderby

      public GetContentOperationSpec.GetContentOperationSpecBuilder orderby(@Nullable @Nullable String orderby)
      Orders the content by a particular field. Specify the field and sort direction for this parameter, as follows: 'fieldpath asc/desc'. For example, 'history.createdDate desc'.
      Gibt zurück:
      this.

    • start

      public GetContentOperationSpec.GetContentOperationSpecBuilder start(@Nullable @Nullable Integer start)
      The starting index of the returned content.
      Gibt zurück:
      this.

    • limit

      public GetContentOperationSpec.GetContentOperationSpecBuilder limit(@Nullable @Nullable Integer limit)
      The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.
      Gibt zurück:
      this.

    • build

      public GetContentOperationSpec build()

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object