Class ContentStates

Index

Constructors

Methods

getAvailableContentStates getContentState getContentStateSettings getCustomContentStates getSpaceContentStates removeContentState setContentState

Constructors

constructor

new ContentStates(client: Client): ContentStates
Parameters
- client: Client
Returns ContentStates
- Defined in src/api/contentStates.ts:8

Methods

getAvailableContentStates

getAvailableContentStates<T = AvailableContentStates>(
parameters: GetAvailableContentStates,
callback: Callback<T>,
): 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
- T = AvailableContentStates
Parameters
- parameters: GetAvailableContentStates
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentStates.ts:143
getAvailableContentStates<T = AvailableContentStates>(
parameters: GetAvailableContentStates,
callback?: undefined,
): Promise<T>
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
- T = AvailableContentStates
Parameters
- parameters: GetAvailableContentStates
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentStates.ts:154

getContentState

getContentState<T = ContentStateResponse>(
parameters: GetContentState,
callback: Callback<T>,
): 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
- T = ContentStateResponse
Parameters
- parameters: GetContentState
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentStates.ts:16
getContentState<T = ContentStateResponse>(
parameters: GetContentState,
callback?: undefined,
): 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
- T = ContentStateResponse
Parameters
- parameters: GetContentState
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentStates.ts:26

getContentStateSettings

getContentStateSettings<T = ContentStateSettings>(
parameters: GetContentStateSettings,
callback: Callback<T>,
): 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
- T = ContentStateSettings
Parameters
- parameters: GetContentStateSettings
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentStates.ts:227
getContentStateSettings<T = ContentStateSettings>(
parameters: GetContentStateSettings,
callback?: undefined,
): 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
- T = ContentStateSettings
Parameters
- parameters: GetContentStateSettings
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentStates.ts:237

getCustomContentStates

getCustomContentStates<T = ContentState[]>(callback: Callback<T>): Promise<void>
Get custom content states that authenticated user has created.

Permissions required Must have user authentication.
Type Parameters
- T = ContentState[]
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentStates.ts:175
getCustomContentStates<T = ContentState[]>(callback?: undefined): Promise<T>
Get custom content states that authenticated user has created.

Permissions required Must have user authentication.
Type Parameters
- T = ContentState[]
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentStates.ts:181

getSpaceContentStates

getSpaceContentStates<T = ContentState[]>(
parameters: GetSpaceContentStates,
callback: Callback<T>,
): Promise<void>
Get content states that are suggested in the space.

Permissions required: Space view permission
Type Parameters
- T = ContentState[]
Parameters
- parameters: GetSpaceContentStates
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentStates.ts:196
getSpaceContentStates<T = ContentState[]>(
parameters: GetSpaceContentStates,
callback?: undefined,
): Promise<T>
Get content states that are suggested in the space.

Permissions required: Space view permission
Type Parameters
- T = ContentState[]
Parameters
- parameters: GetSpaceContentStates
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentStates.ts:205

removeContentState

removeContentState<T = ContentStateResponse>(
parameters: RemoveContentState,
callback: Callback<T>,
): 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
- T = ContentStateResponse
Parameters
- parameters: RemoveContentState
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentStates.ts:107
removeContentState<T = ContentStateResponse>(
parameters: RemoveContentState,
callback?: undefined,
): 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
- T = ContentStateResponse
Parameters
- parameters: RemoveContentState
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentStates.ts:117

setContentState

setContentState<T = ContentStateResponse>(
parameters: SetContentState,
callback: Callback<T>,
): 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
- T = ContentStateResponse
Parameters
- parameters: SetContentState
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentStates.ts:59
setContentState<T = ContentStateResponse>(
parameters: SetContentState,
callback?: undefined,
): 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
- T = ContentStateResponse
Parameters
- parameters: SetContentState
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentStates.ts:77

Class ContentStates

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ContentStates

Methods

getAvailableContentStates

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getContentState

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getContentStateSettings

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getCustomContentStates

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getSpaceContentStates

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeContentState

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

setContentState

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page