Migrate from v0.2.x to v0.3.x
There are a couple fields from v0.2.x which changed in v0.3.x. This guide will walk you through what the changes are and how to update your usage of the SDK for v0.3.x.
config
config
has been removed. It is now possible to set many of the options that were in the config on the Customizations page. You may still pass in overrides at runtime with the SDK by using the customizationOverrides property. In many cases the properties are the same, however some properties changed:
Old property | New property |
---|---|
blockImportIfErrors | Is now handled by importErrorUX . true corresponds to "blockIfErrors" and false corresponds to "promptIfErrors" |
skipExportData | Is now handled by importConfig. If using, set to:{ type: "local", metadataOnly: true } |
contentOptions.upload.uploader.header | uploaderHeaderText |
contentOptions.upload.uploader.subheader | uploaderSubheaderText |
contentOptions.upload.infoSidebar | uploaderShowSidebar |
contentOptions.upload.infoSidebar.hideInfoBanner | uploaderShowSidebarBanner |
contentOptions.upload.infoSidebar.infoBannerText | uploaderSidebarBannerText |
contentOptions.upload.infoSidebar.displayTemplateColumns | uploaderSidebarDetails |
webhookKey
webhookKey
has been removed. It has been replaced with importConfig which allows you to specify both the type of import you want to perform on completion and any settings you were using before.
If you were using webhookKey
replace it with importConfig
with the value being:
{
type: "webhook"
key: YOUR_WEBHOOK_KEY
}
Updated about 1 year ago