Constructors

Properties

client: Client

Methods

  • Gets content states that are available for the content to be set as. Will return all enabled Space Content States. Will only return most the 3 most recently published custom content states to match UI editor list. To get all custom content states, use the /content-states endpoint.

    Permissions required: Permission to edit the content.

    Type Parameters

    Parameters

    Returns Promise<void>

  • Gets content states that are available for the content to be set as. Will return all enabled Space Content States. Will only return most the 3 most recently published custom content states to match UI editor list. To get all custom content states, use the /content-states endpoint.

    Permissions required: Permission to edit the content.

    Type Parameters

    Parameters

    Returns Promise<T>

  • Gets the current content state of the draft or current version of content. To specify the draft version, set the parameter status to draft, otherwise archived or current will get the relevant published state.

    Permissions required: Permission to view the content.

    Type Parameters

    Parameters

    Returns Promise<void>

  • Gets the current content state of the draft or current version of content. To specify the draft version, set the parameter status to draft, otherwise archived or current will get the relevant published state.

    Permissions required: Permission to view the content.

    Type Parameters

    Parameters

    Returns Promise<T>

  • Get object describing whether content states are allowed at all, if custom content states or space content states are restricted, and a list of space content states allowed for the space if they are not restricted.

    Permissions required: Space admin permission

    Type Parameters

    Parameters

    Returns Promise<void>

  • Get object describing whether content states are allowed at all, if custom content states or space content states are restricted, and a list of space content states allowed for the space if they are not restricted.

    Permissions required: Space admin permission

    Type Parameters

    Parameters

    Returns Promise<T>

  • Get custom content states that authenticated user has created.

    Permissions required Must have user authentication.

    Type Parameters

    Parameters

    Returns Promise<void>

  • Get custom content states that authenticated user has created.

    Permissions required Must have user authentication.

    Type Parameters

    Parameters

    • Optional callback: undefined

    Returns Promise<T>

  • Removes the content state of the content specified and creates a new version (publishes the content without changing the body) of the content with the new status.

    Permissions required: Permission to edit the content.

    Type Parameters

    Parameters

    Returns Promise<void>

  • Removes the content state of the content specified and creates a new version (publishes the content without changing the body) of the content with the new status.

    Permissions required: Permission to edit the content.

    Type Parameters

    Parameters

    Returns Promise<T>

  • Sets the content state of the content specified and creates a new version (publishes the content without changing the body) of the content with the new state.

    You may pass in either an id of a state, or the name and color of a desired new state. If all 3 are passed in, id will be used. If the name and color passed in already exist under the current user's existing custom states, the existing state will be reused. If custom states are disabled in the space of the content (which can be determined by getting the content state space settings of the content's space) then this set will fail.

    You may not remove a content state via this PUT request. You must use the DELETE method. A specified state is required in the body of this request.

    Permissions required: Permission to edit the content.

    Type Parameters

    Parameters

    Returns Promise<void>

  • Sets the content state of the content specified and creates a new version (publishes the content without changing the body) of the content with the new state.

    You may pass in either an id of a state, or the name and color of a desired new state. If all 3 are passed in, id will be used. If the name and color passed in already exist under the current user's existing custom states, the existing state will be reused. If custom states are disabled in the space of the content (which can be determined by getting the content state space settings of the content's space) then this set will fail.

    You may not remove a content state via this PUT request. You must use the DELETE method. A specified state is required in the body of this request.

    Permissions required: Permission to edit the content.

    Type Parameters

    Parameters

    Returns Promise<T>

Generated using TypeDoc v0.25.12