Class ContentBody

Index

Constructors

constructor

Methods

asyncConvertContentBodyRequest asyncConvertContentBodyResponse convertContentBody

Constructors

constructor

new ContentBody(client: Client): Api.ContentBody
Parameters
- client: Client
Returns Api.ContentBody
- Defined in src/api/contentBody.ts:8

Methods

asyncConvertContentBodyRequest

asyncConvertContentBodyRequest<T = AsyncId>(
parameters: AsyncConvertContentBodyRequest,
callback: Callback<T>,
): Promise<void>
Converts a content body from one format to another format asynchronously. Returns the asyncId for the asynchronous task.

Supported conversions:
- Storage: export_view
No other conversions are supported at the moment. Once a conversion is completed, it will be available for 5 minutes at the result endpoint.

Permissions required: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.
Type Parameters
- T = AsyncId
Parameters
- parameters: AsyncConvertContentBodyRequest
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentBody.ts:83
asyncConvertContentBodyRequest<T = AsyncId>(
parameters: AsyncConvertContentBodyRequest,
callback?: undefined,
): Promise<T>
Converts a content body from one format to another format asynchronously. Returns the asyncId for the asynchronous task.

Supported conversions:
- Storage: export_view
No other conversions are supported at the moment. Once a conversion is completed, it will be available for 5 minutes at the result endpoint.

Permissions required: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.
Type Parameters
- T = AsyncId
Parameters
- parameters: AsyncConvertContentBodyRequest
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentBody.ts:101

asyncConvertContentBodyResponse

asyncConvertContentBodyResponse<T = AsyncContentBody>(
parameters: AsyncConvertContentBodyResponse,
callback: Callback<T>,
): Promise<void>
Returns the Asynchronous Content Body for the corresponding asyncId if the task is complete or returns the status of the task.

After the task is completed, the result can be obtained for 5 minutes, or until an identical conversion request is made again, with allowCache query param set to false.

Permissions required: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.
Type Parameters
- T = AsyncContentBody
Parameters
- parameters: AsyncConvertContentBodyResponse
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentBody.ts:139
asyncConvertContentBodyResponse<T = AsyncContentBody>(
parameters: AsyncConvertContentBodyResponse,
callback?: undefined,
): Promise<T>
Returns the Asynchronous Content Body for the corresponding asyncId if the task is complete or returns the status of the task.

After the task is completed, the result can be obtained for 5 minutes, or until an identical conversion request is made again, with allowCache query param set to false.

Permissions required: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.
Type Parameters
- T = AsyncContentBody
Parameters
- parameters: AsyncConvertContentBodyResponse
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentBody.ts:153

convertContentBody

convertContentBody<T = Models.ContentBody>(
parameters: ConvertContentBody,
callback: Callback<T>,
): Promise<void>
Converts a content body from one format to another format.

Supported conversions:
- Storage: view, export_view, styled_view, editor
- Editor: storage
- View: none
- Export_view: none
- Styled_view: none
Permissions required: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.
Type Parameters
- T = Models.ContentBody
Parameters
- parameters: ConvertContentBody
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentBody.ts:24
convertContentBody<T = Models.ContentBody>(
parameters: ConvertContentBody,
callback?: undefined,
): Promise<T>
Converts a content body from one format to another format.

Supported conversions:
- Storage: view, export_view, styled_view, editor
- Editor: storage
- View: none
- Export_view: none
- Styled_view: none
Permissions required: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.
Type Parameters
- T = Models.ContentBody
Parameters
- parameters: ConvertContentBody
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentBody.ts:42

Class ContentBody

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Api.ContentBody

Methods

asyncConvertContentBodyRequest

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

asyncConvertContentBodyResponse

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

convertContentBody

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page