From 0b659491137c541b90d9a593c5e65cbc9815c725 Mon Sep 17 00:00:00 2001
From: Vladislav Tupikin Get the total number of views a piece of content has. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Creates a record in the audit log. Exports audit records as a CSV file or ZIP file. Returns all records in the audit log, optionally for a certain date range. This contains information about events
@@ -207,7 +207,7 @@ Returns records from the audit log, for a time period back from the current date. For example, you can use this
@@ -260,7 +260,7 @@ Returns the retention period for records in the audit log. The retention period is how long an audit record is kept
@@ -303,7 +303,7 @@ Sets the retention period for records in the audit log. The retention period can be set to a maximum of 20 years. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Archives a list of pages. The pages to be archived are specified as a list of content IDs. This API accepts the
@@ -125,7 +125,7 @@ Creates a new piece of content or publishes an existing draft. Moves a piece of content to the space's trash or purges it from the trash, depending on the content's type and
@@ -239,7 +239,7 @@ Returns all content in a Confluence instance. Returns a single piece of content, like a page or a blog post. Returns the most recent update for a piece of content. Publishes a legacy draft of a page created from a blueprint. Legacy drafts will eventually be removed in favor of
@@ -427,7 +427,7 @@ Publishes a shared draft of a page created from a blueprint. Returns the list of content that matches a Confluence Query Language (CQL) query. For information on CQL, see:
@@ -533,7 +533,7 @@ Updates a piece of content. Use this method to update the title or body of a piece of content, change the status,
@@ -580,7 +580,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Adds an attachment to a piece of content. This method only adds a new attachment. If you want to update an existing
@@ -115,7 +115,7 @@ Adds an attachment to a piece of content. If the attachment already exists for the content, then the attachment is
@@ -160,7 +160,7 @@ Redirects the client to a URL that serves an attachment's binary data. Returns the attachments for a piece of content. Updates the binary data of an attachment, given the attachment ID, and optionally the comment and the minor edit
@@ -299,7 +299,7 @@ Updates the attachment properties, i.e. the non-binary data of an attachment like the filename, media-type,
@@ -344,7 +344,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Converts a content body from one format to another format asynchronously. Returns the asyncId for the asynchronous
@@ -124,7 +124,7 @@ Returns the Asynchronous Content Body for the corresponding asyncId if the task is complete or returns the status
@@ -175,7 +175,7 @@ Converts a content body from one format to another format. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Copies a single page and its associated properties, permissions, attachments, and custom contents. The Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions
@@ -180,7 +180,7 @@ Returns a map of the direct children of a piece of content. A piece of content has different types of child
@@ -290,7 +290,7 @@ Returns all children of a given type, for a piece of content. A piece of content has different types of child
@@ -355,7 +355,7 @@ Returns a map of the descendants of a piece of content. This is similar to Get content
@@ -422,7 +422,7 @@ Returns all descendants of a given type, for a piece of content. This is similar to Get content children by
@@ -487,7 +487,7 @@ Move a page to a new location relative to a target page: Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns the comments on a piece of content. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Adds labels to a piece of content. Does not modify the existing labels. Returns the labels on a piece of content. Removes a label from a piece of content. This is similar to Remove label from content using query
@@ -217,7 +217,7 @@ Removes a label from a piece of content. This is similar to Remove label from
@@ -266,7 +266,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns Async Id of the conversion task which will convert the macro into a content body of the desired format. The
@@ -126,7 +126,7 @@ Returns the body of a macro in format specified in path, for the given macro ID. This includes information like the
@@ -187,7 +187,7 @@ Returns the body of a macro in storage format, for the given macro ID. This includes information like the name of
@@ -248,7 +248,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Check if a user or a group can perform an operation to the specified content. The Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Creates a property for an existing piece of content. For more information about content properties, see Confluence
@@ -121,7 +121,7 @@ Creates a property for an existing piece of content. For more information about content properties, see Confluence
@@ -174,7 +174,7 @@ Deletes a content property. For more information about content properties, see Confluence entity
@@ -219,7 +219,7 @@ Returns the properties for a piece of content. For more information about content properties, see Confluence
@@ -266,7 +266,7 @@ Returns a content property for a piece of content. For more information, see Confluence entity
@@ -313,7 +313,7 @@ Updates an existing content property. This method will also create a new property for a piece of content, if the
@@ -360,7 +360,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Adds a group to a content restriction. That is, grant read or update permission to the group for a piece of
@@ -122,7 +122,7 @@ Adds a group to a content restriction by Group Id. That is, grant read or update permission to the group for a
@@ -167,7 +167,7 @@ Adds restrictions to a piece of content. Note, this does not change any existing restrictions on the content. Adds a user to a content restriction. That is, grant read or update permission to the user for a piece of content. Removes all restrictions (read and update) on a piece of content. Returns whether the specified content restriction applies to a group. For example, if a page with Returns whether the specified content restriction applies to a user. For example, if a page with Returns whether the specified content restriction applies to a group. For example, if a page with Returns the restrictions on a piece of content. Returns restrictions on a piece of content by operation. This method is similar to Get
@@ -547,7 +547,7 @@ Returns the restictions on a piece of content for a given operation (read or update). Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of
@@ -635,7 +635,7 @@ Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of
@@ -680,7 +680,7 @@ Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of
@@ -725,7 +725,7 @@ Updates restrictions for a piece of content. This removes the existing restrictions and replaces them with the
@@ -770,7 +770,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Gets content states that are available for the content to be set as. Will return all enabled Space Content States.
@@ -116,7 +116,7 @@ Gets the current content state of the draft or current version of content. To specify the draft version, set the
@@ -161,7 +161,7 @@ Get object describing whether content states are allowed at all, if custom content states or space content states
@@ -206,7 +206,7 @@ Get custom content states that authenticated user has created. Get content states that are suggested in the space. Removes the content state of the content specified and creates a new version (publishes the content without
@@ -333,7 +333,7 @@ Sets the content state of the content specified and creates a new version (publishes the content without changing
@@ -390,7 +390,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Delete a historical version. This does not delete the changes made to the content in that version, rather the
@@ -111,7 +111,7 @@ Returns a version for a piece of content. Returns the versions for a piece of content in descending order. Restores a historical version to be the latest version. That is, a new version is created with the content of the
@@ -246,7 +246,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Adds a user as a watcher to a piece of content. Choose the user by doing one of the following: Adds a user as a watcher to a label. Choose the user by doing one of the following: Adds a user as a watcher to a space. Choose the user by doing one of the following: Returns whether a user is watching a piece of content. Choose the user by doing one of the following: Returns a list of watchers of a space Returns the watches for a page. A user that watches a page will receive receive notifications when the page is
@@ -398,7 +398,7 @@ Returns all space watches for the space that the content is in. A user that watches a space will receive receive
@@ -457,7 +457,7 @@ Returns whether a user is watching a label. Choose the user by doing one of the following: Returns whether a user is watching a space. Choose the user by doing one of the following: Removes a user as a watcher from a piece of content. Choose the user by doing one of the following: Removes a user as a watcher from a label. Choose the user by doing one of the following: Removes a user as a watcher from a space. Choose the user by doing one of the following: Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns all modules registered dynamically by the calling app. Registers a list of modules. For the list of modules that support dynamic registration, see Dynamic
@@ -149,7 +149,7 @@ Remove all or a list of modules registered by the calling app. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Adds labels to a piece of content. Does not modify the existing labels. Creates a property for a user. For more information about user properties, see [Confluence entity properties]
@@ -178,7 +178,7 @@ Moves a pagetree rooted at a page to the space's trash: Deletes a property for the given user. For more information about user properties, see Confluence entity
@@ -321,7 +321,7 @@ Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different
@@ -364,7 +364,7 @@ Returns the properties for a user as list of property keys. For more information about user properties, see
@@ -413,7 +413,7 @@ Returns the property corresponding to Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more
@@ -556,7 +556,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Adds a user as a member in a group. Adds a user as a member in a group represented by its groupId Creates a new user group. Returns a user group for a given group id. Returns a user group for a given group name. Returns a user group for a given group name. Returns the users that are members of a group. Returns the users that are members of a group. Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name. Returns the users that are members of a group. Delete user group. Delete user group. Remove user as a member from a group. Remove user as a member from a group. Get search results of groups by partial query provided. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns inline task based on the global ID. Returns inline tasks based on the search query. Updates an inline tasks status given its global ID Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns label information and a list of contents associated with the label. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns information about an active long-running task (e.g. space export), such as how long it has been running and
@@ -111,7 +111,7 @@ Returns information about all active long-running tasks (e.g. space export), such as how long each task has been
@@ -158,7 +158,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Creates a relationship between two entities (user, space, content). The 'favourite' relationship is supported by
@@ -161,7 +161,7 @@ Deletes a relationship between two entities (user, space, content). Returns all target entities that have a particular relationship to the source entity. Note, relationships are one
@@ -304,7 +304,7 @@ Returns all target entities that have a particular relationship to the source entity. Note, relationships are one
@@ -355,7 +355,7 @@ Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships
@@ -406,7 +406,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Searches for content using the Confluence Query Language
@@ -162,7 +162,7 @@ Searches for users using user-specific queries from the Confluence Query Language
@@ -209,7 +209,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns the look and feel settings for the site or a single space. This includes attributes such as the color
@@ -161,7 +161,7 @@ Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian. Resets the custom look and feel settings for the site or a single space. This changes the values of the custom
@@ -249,7 +249,7 @@ Sets the look and feel settings to either the default settings or the custom settings, for the site or a single
@@ -294,7 +294,7 @@ Sets the look and feel settings to the default (global) settings, the custom settings, or the current theme's
@@ -341,7 +341,7 @@ Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated.
@@ -390,7 +390,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Creates a new space that is only visible to the creator. This method is the same as the Create
@@ -117,7 +117,7 @@ Creates a new space. Note, currently you cannot set space labels when creating a space. Deletes a space. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted
@@ -207,7 +207,7 @@ Returns all content of a given type, in a space. The returned content is ordered by content ID in ascending order. Returns all content in a space. The returned content is grouped by type (pages then blogposts), then ordered by
@@ -299,7 +299,7 @@ Returns a space. This includes information like the name, description, and permissions, but not the content in the
@@ -344,7 +344,7 @@ Returns all spaces. The returned spaces are ordered alphabetically in ascending order by space key. Updates the name, description, or homepage of a space. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Adds new custom content permission to space. Adds new permission to space. Removes a space permission. Note that removing Read Space permission for a user or group will remove all the space
@@ -250,7 +250,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Creates a new space property. Creates a new space property. This is the same as Deletes a space property. Returns all properties for the given space. Space properties are a key-value storage associated with a space. Returns a space property. Updates a space property. Note, you cannot update the key of a space property, only the value. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns the settings of a space. Currently only the Updates the settings for a space. Currently only the Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Creates a new content template. Note, blueprint templates cannot be created via the REST API. Returns all templates provided by blueprints. Use this method to retrieve all global blueprint templates or all
@@ -166,7 +166,7 @@ Returns a content template. This includes information about template, like the name, the space or blueprint that
@@ -215,7 +215,7 @@ Returns all content templates. Use this method to retrieve all global content templates or all content templates in
@@ -264,7 +264,7 @@ Deletes a template. This results in different actions depending on the type of template: Updates a content template. Note, blueprint templates cannot be updated via the REST API. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns the globally assigned theme. Returns the theme selected for a space, if one is set. If no space theme is set, this means that the space is
@@ -152,7 +152,7 @@ Returns a theme. This includes information about the theme name, description, and icon. Returns all themes, not including the default theme. Resets the space theme. This means that the space will inherit the global look and feel settings Sets the theme for a space. Note, if you want to reset the space theme to the default Confluence theme, use the
@@ -326,7 +326,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns information about how anonymous users are represented, like the profile picture and display name. Returns user details for the ids provided in request. Returns the accountIds for the users specified in the key or username parameters. Note that multiple key and
@@ -207,7 +207,7 @@ Returns the currently logged-in user. This includes information about the user, like the display name, userKey,
@@ -254,7 +254,7 @@ Returns the groups that a user is a member of. Returns a user's email address. This API is only available to apps approved by Atlassian, according to these
@@ -346,7 +346,7 @@ Returns user email addresses for a set of accountIds. This API is only available to apps approved by Atlassian,
@@ -397,7 +397,7 @@ Returns a user. This includes information about the user, such as the display name, account ID, profile picture,
@@ -448,7 +448,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Creates a record in the audit log. Exports audit records as a CSV file or ZIP file. Fetch a paginated list of AuditRecord instances dating back to a certain time Fetch a paginated list of AuditRecord instances dating back to a certain time Fetches the current retention periodResponses Set the retention period to a new value. Can throw ServiceException if the retention period is too long Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Adds a list of labels to the specified content. The body is the json representation of the list. Add one or more attachments to a Confluence Content entity, with optional comments. Creates a new piece of Content or publishes the draft if the content id is present.For the case publishing draft, a
@@ -255,7 +255,7 @@ Creates a new content property. Creates a new content property. Trashes or purges a piece of Content, based on its ContentType and ContentStatus. There are three cases: Deletes a content property. Deletes a labels to the specified content. When calling this method through REST the label parameter doesn't accept
@@ -476,7 +476,7 @@ Deletes a labels to the specified content. Returns a paginated list of attachment Content entities within a single container. Returns a paginated list of Content. Returns a piece of Content. Returns a map of the direct children of a piece of Content. Content can have multiple types of children - for
@@ -691,7 +691,7 @@ Returns the direct children of a piece of Content, limited to a single child type. Returns the comments of a content Returns a map of the descendants of a piece of Content. Content can have multiple types of descendants - for
@@ -828,7 +828,7 @@ Returns the direct descendants of a piece of Content, limited to a single descendant type. Returns the list of labels on a piece of Content. Returns a paginated list of content properties. Returns a content property. Returns the history of a particular piece of content Returns the body of a macro (in storage format) with the given hash. This resource is primarily used by connect
@@ -1096,7 +1096,7 @@ Returns the body of a macro (in storage format) with the given id. This resource is primarily used by connect
@@ -1149,7 +1149,7 @@ Returns info about all restrictions by operation Returns info about all restrictions of given operation Publishes a legacy draft of a Content created from a ContentBlueprint Publishes a shared draft of a Content created from a ContentBlueprint Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL Update the binary data of an Attachment, and optionally the comment and the minor edit field. This adds a new
@@ -1429,7 +1429,7 @@ Update the non-binary data of an Attachment. Updates a piece of Content, including changes to content status To update a piece of content you must increment the
@@ -1517,7 +1517,7 @@ Updates a content property. The body contains the representation of the content property. Must include the property
@@ -1564,7 +1564,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Converts between content body representations. Not all representations can be converted to/from other formats.
@@ -120,7 +120,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Get the user group with the group name Get a paginated collection of user groups Get a paginated collection of users in the given group Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns information about a long-running task. Returns information about all tracked long-running tasks. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Search for entities in Confluence using the Confluence Query Language (CQL) Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Creates a new private Space, viewable only by its creator. Creates a new Space. Creates a new space property. Creates a new space property. Deletes a Space. Deletes a space property. Returns the content in this given space with the given type Returns the content in this given space Returns information about a space. Returns a paginated list of space properties. Returns a paginated list of space properties. Returns information about a number of spaces. Updates a Space. Currently only the Space name, description and homepage can be updated. Updates a space property. The body contains the representation of the space property. Must include new version
@@ -662,7 +662,7 @@ Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Create a new watcher for the given user and content id. Create a new watcher for the given user and space key. Get information about the how anonymous is represented in confluence Get information about whether a user is watching a specified content. Get information about the current logged-in user. Get a paginated collection of groups that the given user is a member of Get information about a user identified by either user key or username. Get information about whether a user is watching a specified space. Delete an existing watcher for the given user and content id. Delete an existing watcher for the given user and space key. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns all of the users who have contributed to the content. This property is only used by Atlassian. Returns the history of the content, including the date it was created. Returns inline comment-specific properties. Returns the labels that have been added to the content. Returns information about the most recent update of the content, including who updated it and when it was updated. Returns information about the update after to the current content update. Returns the operations for the content, which are used when setting permissions. Returns whether the content has child pages. Returns pages that are descendants at the level immediately below the content. Returns pages that are descendants at any level below the content. Returns information about the update prior to the current content update. Returns content properties that have been set via the Confluence REST API. Returns the users that have permission to read the content. Returns the resolution status of each comment. Returns the users that have permission to update the content. Returns information about the most recent update of the content, including who updated it and when it was updated. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns all of the users who have contributed to the content. This property is only used by Atlassian. Returns the history of the content, including the date it was created. Returns inline comment-specific properties. Returns the labels that have been added to the content. Returns information about the most recent update of the content, including who updated it and when it was updated. Returns information about the update after to the current content update. Returns the operations for the content, which are used when setting permissions. Returns whether the content has child pages. Returns pages that are descendants at the level immediately below the content. Returns pages that are descendants at any level below the content. Returns information about the update prior to the current content update. Returns content properties that have been set via the Confluence REST API. Returns the users that have permission to read the content. Returns the resolution status of each comment. Returns the users that have permission to update the content. Returns information about the most recent update of the content, including who updated it and when it was updated. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns all of the users who have contributed to the content. This property is only used by Atlassian. Returns the history of the content, including the date it was created. Returns inline comment-specific properties. Returns the labels that have been added to the content. Returns information about the most recent update of the content, including who updated it and when it was updated. Returns information about the update after to the current content update. Returns the operations for the content, which are used when setting permissions. Returns whether the content has child pages. Returns pages that are descendants at the level immediately below the content. Returns pages that are descendants at any level below the content. Returns information about the update prior to the current content update. Returns content properties that have been set via the Confluence REST API. Returns the users that have permission to read the content. Returns the resolution status of each comment. Returns the users that have permission to update the content. Returns information about the most recent update of the content, including who updated it and when it was updated. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns all of the users who have contributed to the content. This property is only used by Atlassian. Returns the history of the content, including the date it was created. Returns inline comment-specific properties. Returns the labels that have been added to the content. Returns information about the most recent update of the content, including who updated it and when it was updated. Returns information about the update after to the current content update. Returns the operations for the content, which are used when setting permissions. Returns whether the content has child pages. Returns pages that are descendants at the level immediately below the content. Returns pages that are descendants at any level below the content. Returns information about the update prior to the current content update. Returns content properties that have been set via the Confluence REST API. Returns the users that have permission to read the content. Returns the resolution status of each comment. Returns the users that have permission to update the content. Returns information about the most recent update of the content, including who updated it and when it was updated. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns all of the users who have contributed to the content. This property is only used by Atlassian. Returns the history of the content, including the date it was created. Returns inline comment-specific properties. Returns the labels that have been added to the content. Returns information about the most recent update of the content, including who updated it and when it was updated. Returns information about the update after to the current content update. Returns the operations for the content, which are used when setting permissions. Returns whether the content has child pages. Returns pages that are descendants at the level immediately below the content. Returns pages that are descendants at any level below the content. Returns information about the update prior to the current content update. Returns content properties that have been set via the Confluence REST API. Returns the users that have permission to read the content. Returns the resolution status of each comment. Returns the users that have permission to update the content. Returns information about the most recent update of the content, including who updated it and when it was updated. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Returns all of the users who have contributed to the content. This property is only used by Atlassian. Returns the history of the content, including the date it was created. Returns inline comment-specific properties. Returns the labels that have been added to the content. Returns information about the most recent update of the content, including who updated it and when it was updated. Returns information about the update after to the current content update. Returns the operations for the content, which are used when setting permissions. Returns whether the content has child pages. Returns pages that are descendants at the level immediately below the content. Returns pages that are descendants at any level below the content. Returns information about the update prior to the current content update. Returns content properties that have been set via the Confluence REST API. Returns the users that have permission to read the content. Returns the resolution status of each comment. Returns the users that have permission to update the content. Returns information about the most recent update of the content, including who updated it and when it was updated. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 false A unique key to identify the app. This key must be <= 64 characters. Allows the app to register for app lifecycle notifications. A set of links that the app wishes to publish. The list of modules this app provides. Set of scopes requested by this app. The URL for the vendor's website. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 The media type of the attachment, e.g. 'img/jpg'. The updated name of the attachment. Set this to The version number. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 A long description of the event, which is displayed in the 'Description' field on the audit log in the Confluence UI. The IP address of the computer where the event was initiated from. The summary of the event, which is displayed in the 'Change' column on the audit log in the Confluence UI. Indicates whether the event was actioned by a system administrator. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 The account type of the user, may return empty string if unavailable. The display name of the user. Depending on the user's privacy setting, this may be the same as publicName. The email address of the user. Depending on the user's privacy setting, this may return an empty string. The public name or nickname of the user. Will always contain a value. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 The status of the content. Set this to The title of the content. If you don't want to change the title, set this to the current title of the draft. The type of content. Set this to The version number. Set this to Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 The ID of the draft content. Required when publishing a draft. The key of the space. The status of the new content. The type of the new content. Custom content types defined by apps are also supported. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 The updated title of the content. If you are not changing this field, set this to the current The type of content. Set this to the current type of the content. The version number. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 The host product description - this is customisable by an instance administrator. App key that was installed into the Atlassian Product, as it appears in your app's descriptor. This is a SemVer-compliant
host server, for example: Identifies the category of Atlassian product, e.g. This is the public key for this Atlassian product instance. This field is deprecated and should not be used. This is a string representation of the host product's version. Generally you should not need it. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 The name of the space. The updated status for this space. The updated type for this space. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 The account type of the user, may return empty string if unavailable. The display name of the user. Depending on the user's privacy setting, this may be the same as publicName. The email address of the user. Depending on the user's privacy setting, this may return an empty string. The public name or nickname of the user. Will always contain a value. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 This property has been deprecated due to privacy changes.
for details. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 The name of the label to add the watcher to. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Inherited from SpacePermissionV2.operation The key of the space to be queried for its content. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Inherited from SpacePermissionRequest.operation The key of the space to be queried for its content. Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 Generated using TypeDoc v0.23.23 Generated using TypeDoc v0.23.28 The key of the space to add the watcher to.=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends I{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{He(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?pe(e,-1):s.key==="ArrowDown"?pe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ae(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function He(t,e,n,r){if(Ae(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;o=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends I{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{He(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?pe(e,-1):s.key==="ArrowDown"?pe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ae(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function He(t,e,n,r){if(Ae(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oReturns Promise<void>
+Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
export
@@ -137,7 +137,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -184,7 +184,7 @@
parameters: undefinedCallback
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -235,7 +235,7 @@
parameters: undefinedCallback
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -283,7 +283,7 @@
Parameters
callback: Callback<T>
Returns Promise<void>
+Parameters
Optional
callback: undefinedReturns Promise<T>
set
@@ -327,7 +327,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
create
@@ -153,7 +153,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
delete
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -264,7 +264,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
publish
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
publish
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
search
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
update
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
create
@@ -139,7 +139,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
download
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
update
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
update
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
async
@@ -151,7 +151,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
convert
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+id
path
@@ -131,7 +131,7 @@ parameters: Optional callback: undefined
Returns Promise<T>
copy
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
descendants
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
move
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -140,7 +140,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -184,7 +184,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
remove
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
set
@@ -279,7 +279,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
remove
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
remove
@@ -243,7 +243,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -158,7 +158,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+operation
to check must be
@@ -127,7 +127,7 @@ parameters:
Optional
callback: undefinedReturns Promise<T>
permission
@@ -150,7 +150,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
create
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
delete
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
update
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
add
@@ -146,7 +146,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
add
@@ -190,7 +190,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
add
@@ -233,7 +233,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
delete
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -324,7 +324,7 @@
parameters: Callback<T>
Returns Promise<void>
+id=123
has a
@@ -349,7 +349,7 @@ parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -378,7 +378,7 @@
parameters: Callback<T>
Returns Promise<void>
+id=123
has a
@@ -404,7 +404,7 @@ parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -432,7 +432,7 @@
parameters: Callback<T>
Returns Promise<void>
+id=123
has a
@@ -457,7 +457,7 @@ parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -480,7 +480,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
remove
@@ -614,7 +614,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
remove
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
remove
@@ -704,7 +704,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
update
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -140,7 +140,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -227,7 +227,7 @@
Parameters
callback: Callback<T>
Returns Promise<void>
+Parameters
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
remove
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
set
@@ -363,7 +363,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
restore
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
add
@@ -161,7 +161,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
add
@@ -218,7 +218,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
is
@@ -485,7 +485,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
is
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
remove
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
remove
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
remove
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+Parameters
Optional
callback: undefinedReturns Promise<T>
register
@@ -128,7 +128,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
remove
@@ -172,7 +172,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
create
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
delete
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
delete
@@ -245,7 +245,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
delete
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -439,7 +439,7 @@
parameters: Callback<T>
Returns Promise<void>
+key
for a user. For more information about user properties, see Confluence
@@ -462,7 +462,7 @@ parameters: Optional callback: undefined
Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
update
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
add
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
create
@@ -188,7 +188,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -321,7 +321,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -413,7 +413,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -506,7 +506,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -550,7 +550,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
remove
@@ -638,7 +638,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
remove
@@ -681,7 +681,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
remove
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
remove
@@ -767,7 +767,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
search
@@ -809,7 +809,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
search
@@ -134,7 +134,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
update
@@ -179,7 +179,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -136,7 +136,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
create
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
delete
@@ -184,7 +184,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
delete
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
find
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
find
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -382,7 +382,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
search
@@ -137,7 +137,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
search
@@ -187,7 +187,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
user
@@ -232,7 +232,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -138,7 +138,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -183,7 +183,7 @@
Parameters
callback: Callback<T>
Returns Promise<void>
+Parameters
Optional
callback: undefinedReturns Promise<T>
reset
@@ -227,7 +227,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
set
@@ -273,7 +273,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
update
@@ -319,7 +319,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
update
@@ -367,7 +367,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
create
@@ -140,7 +140,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
delete
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -369,7 +369,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
update
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
add
@@ -136,7 +136,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
add
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
remove
@@ -228,7 +228,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
create
Returns Promise<void>
+POST /api/space/{spaceKey}/property
but the key for the
@@ -156,7 +156,7 @@ parameters:
Optional
callback: undefinedReturns Promise<T>
delete
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
update
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+routeOverrideEnabled
setting can be returned.parameters: Optional callback: undefined
Returns Promise<T>
update
Returns Promise<void>
+routeOverrideEnabled
setting can be updated.parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -141,7 +141,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -241,7 +241,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
remove
@@ -296,7 +296,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
update
@@ -349,7 +349,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+Parameters
Optional
callback: undefinedReturns Promise<T>
get
@@ -131,7 +131,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -175,7 +175,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -218,7 +218,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
reset
@@ -261,7 +261,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
set
@@ -305,7 +305,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -232,7 +232,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -278,7 +278,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -324,7 +324,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -373,7 +373,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
+
+Returns string
+Protected
param
@@ -124,7 +124,7 @@
Parameters
parameters: Record<string, any>
Returns string
+Protected
remove
@@ -137,7 +137,7 @@
Parameters
obj: Record<string, any>
Returns Record<string, any>
send
@@ -160,7 +160,7 @@
Optional
telemetryData: Returns Promise<T>
+Optional
telemetryData: Returns Promise<void>
+
+
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
export
@@ -131,7 +131,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -172,7 +172,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -213,7 +213,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -252,7 +252,7 @@
Parameters
callback: Callback<T>
Returns Promise<void>
+Parameters
Optional
callback: undefinedReturns Promise<T>
set
@@ -291,7 +291,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
create
@@ -174,7 +174,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
create
@@ -234,7 +234,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
create
@@ -277,7 +277,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
create
@@ -318,7 +318,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
delete
@@ -365,7 +365,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
delete
@@ -412,7 +412,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
delete
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
delete
@@ -498,7 +498,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -539,7 +539,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -580,7 +580,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -621,7 +621,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -667,7 +667,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -714,7 +714,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -756,7 +756,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -803,7 +803,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -852,7 +852,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -936,7 +936,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -977,7 +977,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -1018,7 +1018,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -1124,7 +1124,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -1171,7 +1171,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -1212,7 +1212,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
publish
@@ -1253,7 +1253,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
publish
@@ -1294,7 +1294,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
search
@@ -1335,7 +1335,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
update
@@ -1393,7 +1393,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
update
@@ -1452,7 +1452,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
update
@@ -1496,7 +1496,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
update
@@ -1542,7 +1542,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -128,7 +128,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -169,7 +169,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -127,7 +127,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
create
@@ -142,7 +142,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
create
@@ -184,7 +184,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
create
@@ -225,7 +225,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
delete
@@ -268,7 +268,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
delete
@@ -311,7 +311,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -393,7 +393,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -434,7 +434,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -475,7 +475,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -516,7 +516,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -557,7 +557,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
update
@@ -598,7 +598,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
update
@@ -641,7 +641,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
add
Returns Promise<void>
+parameters:
Optional
callback: undefinedReturns Promise<T>
get
@@ -186,7 +186,7 @@
Parameters
callback: Callback<T>
Returns Promise<void>
+Parameters
Optional
callback: undefinedReturns Promise<T>
get
@@ -228,7 +228,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
get
@@ -272,7 +272,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -313,7 +313,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
get
@@ -354,7 +354,7 @@
parameters: undefinedCallback<T>
Returns Promise<void>
+Optional
parameters: Optional callback: undefinedReturns Promise<T>
is
@@ -398,7 +398,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
remove
@@ -445,7 +445,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
remove
@@ -492,7 +492,7 @@
parameters: Callback<T>
Returns Promise<void>
+parameters: Optional callback: undefined
Returns Promise<T>
+
+
+
+
+
+Contributors
Current
Current
Frontend
History
Inline
Labels
Last
Next
Operations
Page
Page
Page
Previous
Properties
Read
Read
Read
Resolution
Space
Space
-
Update
Update
Update
Version
+
+Contributors
Current
Current
Frontend
History
Inline
Labels
Last
Next
Operations
Page
Page
Page
Previous
Properties
Read
Read
Read
Resolution
Space
Space
-
Update
Update
Update
Version
+
+Contributors
Current
Current
Frontend
History
Inline
Labels
Last
Next
Operations
Page
Page
Page
Previous
Properties
Read
Read
Read
Resolution
Space
Space
-
Update
Update
Update
Version
+
+Contributors
Current
Current
Frontend
History
Inline
Labels
Last
Next
Operations
Page
Page
Page
Previous
Properties
Read
Read
Read
Resolution
Space
Space
-
Update
Update
Update
Version
+
+Contributors
Current
Current
Frontend
History
Inline
Labels
Last
Next
Operations
Page
Page
Page
Previous
Properties
Read
Read
Read
Resolution
Space
Space
-
Update
Update
Update
Version
+
+Contributors
Current
Current
Frontend
History
Inline
Labels
Last
Next
Operations
Page
Page
Page
Previous
Properties
Read
Read
Read
Resolution
Space
Space
-
Update
Update
Update
Version
+
+
+
+
+
+Returns Promise<void>
+
+
+
+
+
+
+
+
+
+
+
+base
base
Optional
descriptionOptional
Optional
enableOptional
Defaultkey
Optional
lifecycleOptional
linksOptional
modulesOptional
nameOptional
Optional
scopesOptional
vendor
name: string;
url: string;
}url:
+
+Optional
renderOptional
representationOptional
statusOptional
Optional
valueOptional
webresource
+
+
+
+
+
+id
macro
status
title
type
+
+media
+
+Optional
metadata
comment?: string;
mediaType?: string;
}Optional
mediaOptional
titletype
attachment
.version
number: number;
}number:
+
+
+
+
+
+Optional
descriptionremote
Optional
summaryOptional
sys
+
+
+
+referencing
template
template
+
+
+
+
+
+account
Optional
detailsdisplay
email
Optional
operationsOptional
personalprofile
public
type
Optional
userOptional
deprecation notice for details.
Optional
usernameOptional
deprecation notice for details.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Optional
spacestatus
title
type
Optional
version
+
+
+
+
+
+
+
+Optional
statuscurrent
or omit it altogether.title
type
page
.version
number: number;
}number:
1
.
+
+
+
+
+
+
+
+
@@ -80,7 +80,7 @@ Optional
comment_links:
value: boolean
@@ -92,7 +92,7 @@ Optional
page_links:
value: boolean
+
+
+
+
+
+Optional
idspace
key: string;
}key:
Optional
statustitle
type
+
+created
created
Optional
lastlatest
Optional
nextOptional
previous
+
+
+
+
+
+Optional
labelsOptional
properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+title
title
.type
version
number: number;
}number:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Optional
descriptionOptional
displayOptional
Optional
keyOptional
oauthOptional
Optional
pluginsDeprecated
1.1.15
.Optional
productjira
or confluence
.Optional
publicOptional
DeprecatedOptional
serverOptional
DeprecatedOptional
serviceOptional
Optional
sharedOptional
installed event. All instances of your app use the same shared secret.
+
+percentage
Optional
statussuccessful
+
+
+
+percentage
Optional
statussuccessful
+
+Optional
horizontallinks
color: string;
}Type declaration
color: string
menus
Optional
space
+
+
+
+
+
+Optional
horizontallinks
color: string;
}Type declaration
color: string
menus
Optional
space
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Optional
targetOptional
Type declaration
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Optional
history
createdDate: string;
}Type declaration
created
Optional
homepageOptional
iconid
key
Optional
look
@@ -139,42 +139,42 @@ Optional
metadataType declaration
labels: Models.LabelArray
name
Optional
operationsOptional
permissionsOptional
settingsstatus
Optional
themetype
+
+
+
+
+
+
+
+
+
+unlicensed
+
+unlicensed
+
+
+
+subject
+
+subject
+
+
+
+Optional
version
message: string;
minorEdit: boolean;
number: number;
when: string;
}number:
when: string
+
+
+
+value
+
+
+
+
+
+
+
+
+
+Optional
nameOptional
statusOptional
type
+
+
+
+
+
+Optional
usernameOptional
deprecation notice for details.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+account
Optional
detailsdisplay
email
Optional
operationsOptional
personalprofile
public
type
Optional
userOptional
deprecation notice for details.
Optional
usernameOptional
deprecation notice for details.
+
+
+
+
+
+
+
+Optional
personal
email?: string;
im?: string;
phone?: string;
website?: string;
}Deprecated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Optional
usernameOptional
deprecation notice for details.
+
+
+
+
+
+Optional
usernameOptional
deprecation notice for details.
+
+
+
+
+
+
+
+Optional
keyOptional
deprecation notice for details.
label
Optional
usernameOptional
deprecation notice for details.
+
+
+
+
+
+Optional
idoperation
key: string;
target: string;
}target:
-
space
subject
+
+operation
key: string;
target: string;
}target:
-
space
subject
+
+
+
+Optional
keyOptional
deprecation notice for details.
space
Optional
usernameOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The operation that the restriction applies to.
Optional
userOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
contentOptional
Optional
embeddedMode used for rendering embedded content, like attachments.
-- `current` renders the embedded content using the latest version.
- `version-at-save` renders the embedded content using the version at
the time of save.
+- `current` renders the embedded content using the latest version.
- `version-at-save` renders the embedded content using the version at
the time of save.
Optional
expandA multi-value parameter indicating which properties of the content to expand and populate.
Optional
spaceOptional
The name of the target format for the content body.
Inherited from ContentBodyCreate.value
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
embeddedOptional
Optional
expandOptional
Optional
spaceOptional
The name of the target format for the content body.
Inherited from ContentBodyCreate.value
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
categoryOptional
Optional
changedOptional
Optional
creationOptional
Optional
descriptionOptional
Inherited from AuditRecordCreate.remoteAddress
Optional
summaryOptional
Optional
sysOptional
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Inherited from ContentTemplateCreate.templateType
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
targetThe status of the target. This parameter is only used when the targetType
is 'content'.
The target entity type of the relationship. This must be 'space' or 'content', if the relationName
is 'favourite'.
Optional
targetOptional
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
sourceThe status of the source. This parameter is only used when the sourceType
is 'content'.
The source entity type of the relationship. This must be 'user', if the relationName
is 'favourite'.
Optional
sourceOptional
Optional
targetThe status of the target. This parameter is only used when the targetType
is 'content'.
The target entity type of the relationship. This must be 'space' or 'content', if the relationName
is 'favourite'.
Optional
targetOptional
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
sourceThe status of the source. This parameter is only used when the sourceType
is 'content'.
The source entity type of the relationship. This must be 'user', if the relationName
is 'favourite'.
Optional
sourceOptional
Optional
targetThe status of the target. This parameter is only used when the targetType
is 'content'.
The target entity type of the relationship. This must be 'space' or 'content', if the relationName
is 'favourite'.
Optional
targetOptional
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
startThe starting index of the returned relationships.
Optional
targetThe status of the target. This parameter is only used when the targetType
is 'content'.
The target entity type of the relationship.
Optional
targetOptional
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
sourceThe status of the source. This parameter is only used when the sourceType
is 'content'.
The source entity type of the relationship.
Optional
sourceOptional
Optional
startThe starting index of the returned relationships.
Optional
targetThe status of the target. This parameter is only used when the targetType
is 'content'.
The target entity type of the relationship.
Optional
targetOptional
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
spaceOptional
The content representation to return the macro in. Currently, the following conversions are allowed:
--`export_view` - `styled_view` - `view`;
+-`export_view` - `styled_view` - `view`;
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The content representation to return the macro in.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
startThe starting index of the returned templates.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
limitOptional
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
postingThe posting date of the blog post to be returned. Required for blogpost
type. Format: yyyy-mm-dd
.
Optional
spaceThe key of the space to be queried for its content.
Optional
startThe starting index of the returned content.
Optional
statusOptional
historical status is currently not supported.
Optional
titleThe title of the page to be returned. Required for page
type.
Optional
triggerOptional
Optional
typeThe type of content to return.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
statusOptional
historical status is currently not supported.
Optional
triggerOptional
Optional
versionThe version number of the content to be returned.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
parentThe version of the parent content to retrieve children for. Currently, this only works for the latest version.
Optional
startThe starting index of the returned comments.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The operation that is restricted.
Optional
userOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
idThe id of the content whose content state is of interest.
Optional
statusSet status to one of [current,draft,archived].
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
usernameOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
startThe starting index of the returned users.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
limitThe maximum number of groups to return per page. Note, this may be restricted by fixed system limits.
Optional
startThe starting index of the returned groups.
Optional
usernameOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
startThe starting index of the returned labels.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The version of the content that contains the macro.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
startThe starting index of the returned users.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
sourceThe status of the source. This parameter is only used when the sourceType
is 'content'.
The source entity type of the relationship. This must be 'user', if the relationName
is 'favourite'.
Optional
sourceOptional
Optional
targetThe status of the target. This parameter is only used when the targetType
is 'content'.
The target entity type of the relationship. This must be 'space' or 'content', if the relationName
is 'favourite'.
Optional
targetOptional
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
startThe starting index of the users and groups in the returned restrictions.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The operation type of the restrictions to be returned.
Optional
startThe starting index of the users and groups in the returned restrictions.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
favouriteOptional
Leave blank for the current user. Use Get user to get the userKey for a user.
Optional
labelFilter the results to spaces based on their label.
Optional
limitThe maximum number of spaces to return per page. Note, this may be restricted by fixed system limits.
Optional
spaceThe id of the space to be returned. To return multiple spaces, specify this parameter multiple times with different values.
Optional
spaceThe key of the space to be returned. To return multiple spaces, specify this parameter multiple times with different values.
Optional
startThe starting index of the returned spaces.
Optional
statusFilter the results to spaces based on their status.
Optional
typeFilter the results to spaces based on their type.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
keyOptional
deprecation notice for details.
Optional
usernameOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The name of the label to be queried for whether the specified user is watching it.
Optional
usernameOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The key of the space to be queried for whether the specified user is watching it.
Optional
usernameOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The ID of the target page for this operation
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The ID of the content to remove the watcher from.
Optional
keyOptional
deprecation notice for details.
Optional
usernameOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The name of the label to remove the watcher from.
Optional
usernameOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The key of the space to remove the watcher from.
Optional
usernameOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The operation that the restriction applies to.
Optional
userOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
cursorPointer to a set of search results, returned as part of the next or prev URL from the previous search call.
Optional
includeOptional
Defaultfalse
Optional
limit25
0
Optional
startThe starting index of the returned users.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
cursorPointer to a set of search results, returned as part of the next
or prev
URL from the previous search call.
Optional
expandA multi-value parameter indicating which properties of the content to expand.
Optional
limitThe maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
startThe starting index of the returned groups.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
limitThe maximum number of user objects to return per page. Note, this may be restricted by fixed system limits.
Optional
startThe starting index of the returned users.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
idThe Id of the content whose content state is to be set.
Optional
nameOptional
Optional
stateOptional
Optional
statusOptional
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The ID of the content that the attachment is attached to.
Optional
updateGenerated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Inherited from ContentPropertyUpdate.version
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Inherited from ContentTemplateUpdate.templateType
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
horizontalOptional
spaceOptional
Optional
spaceGenerated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
start0
0
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
metadataOptional
mediaThe media type of the attachment, e.g. 'img/jpg'.
Optional
titleThe updated name of the attachment.
Set this to attachment
.
The version number.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
spaceOptional
versionGenerated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
commentOptional
pageGenerated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
lastOptional
nextOptional
previousGenerated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
statusGenerated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
historyOptional
homepageOptional
iconOptional
lookOptional
metadataOptional
operationsOptional
permissionsOptional
settingsOptional
themeGenerated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
versionGenerated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
The account type of the user, may return empty string if unavailable.
Optional
detailsThe display name of the user. Depending on the user's privacy setting, this may be the same as publicName.
The email address of the user. Depending on the user's privacy setting, this may return an empty string.
Optional
operationsOptional
personalThe public name or nickname of the user. Will always contain a value.
Optional
userOptional
deprecation notice for details.
Optional
usernameOptional
deprecation notice for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
personalThis property has been deprecated due to privacy changes. for details.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
categoryThe category of the event, which is displayed in the 'Event type' column on the audit log in the Confluence UI.
Optional
changedThe values that were changed in the event.
Optional
creationOptional
creationDate is not specified, then it will be set to the timestamp for the current date-time.
Optional
descriptionA long description of the event, which is displayed in the 'Description' field on the audit log in the Confluence UI.
The IP address of the computer where the event was initiated from.
Optional
summaryThe summary of the event, which is displayed in the 'Change' column on the audit log in the Confluence UI.
Optional
sysIndicates whether the event was actioned by a system administrator.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
searchOptional
startWhere to start within results set
Optional
unitsThe units to use for the time periods eg. 'days', 'months' etc
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
titleThe title of the page to find. Required for page type.
Optional
typeThe content type to return. Default value: page. Valid values: page, blogpost.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
limit(optional, default: site limit) how many items should be returned after the start index
Optional
locationOptional
Optional
parentAn int representing the version of the content to retrieve children for
Optional
start(optional, default: 0) the index of the first item within the result set that should be returned
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
excerptThe excerpt strategy to apply to the result, one of : indexed, highlight, none. This defaults to highlight.
Optional
expandThe properties to expand on the search result, this may cause database requests for some properties
Optional
includeWhether to include content in archived spaces in the result, this defaults to false
Optional
limitThe limit of the number of items to return, this may be restricted by fixed system limits
Optional
startThe start point of the collection to return
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
titleOptional
Inherited from AttachmentUpdate.type
Inherited from AttachmentUpdate.version
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Optional
nameThe name of the space.
The key of the space to update.
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Generated using TypeDoc v0.23.23
+
Generated using TypeDoc v0.23.28
+
Get the total number of distinct viewers a piece of content has.
@@ -105,7 +105,7 @@parameters:
Optional
callback: undefined