convertFromRicosDocument( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Converts a Ricos document to the specified format.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Ricos Document
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
documentRichContentRequired

Ricos document to convert.

See the child properties of this field in the Ricos Document reference.

targetFormatTargetFormatRequired

Format to convert the document to.

optionsConvertFromRicosDocumentOptions

Options to use when converting from a Ricos document.

Returns
Return Type:Promise<ConvertFromRicosDocumentResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?