Migration guide

🚧

What about the legacy plugin SDK?

With the release of the plugin SDK v1, the legacy version is now deprecated. While still supported, new features and improvements will be exclusive to the current version.

You can access the legacy documentation here.

Why a new version?

Since the legacy version of the plugin SDK was first designed and built, both Javascript and Front saw a lot of changes.

In addition to performance improvements, this new version brings support of promises and TypeScript, a data model closer to the one exposed by the Core API, etc...

API correspondence table

Legacy SDKCurrent SDKNotes
Front.on('conversation', ...)
Front.on('no_conversation', ...)
Front.contextUpdates.subscribe(...);cf: Front.contextUpdates
Front.assign
Front.unassign
Front.assigncf: assign
Front.toggleArchive
Front.toggleTrashed
Front.setStatuscf: setStatus
Front.moveToInboxFront.movecf: move
Front.attachTagFront.tagcf: tag
Front.detachTagFront.untagcf: untag
Front.addTopicFront.addTopiccf: addTopic
Front.compose
Front.reply
Front.forward
Front.createDraftcf: createDraft
Front.updateDraft
Front.insertHtml
Front.updateDraftcf: updateDraft
Front.openUrlFront.openUrlcf: openUrl
Front.openPopupUrlFront.openUrlInPopupcf: openUrlInPopup
Front.searchFront.searchcf: search
Front.fetchTeamFront.listTeammatescf: listTeammates
Front.fetchInboxesFront.listInboxescf: listInboxes
Front.fetchChannelsFront.listChannelscf: listChannels
Front.user-The current teammate is now accessible on context.teammate.
Front.listAllowedTeammates-All teammates can be listed using listTeammates
Front.listAllowedTags-All tags can be listed using listTags
Front.fetchDraftFront.fetchDraftcf: fetchDraft
Front.copyToClipboard
Front.prompt
Front.promptDate
Front.fuzzylist
Front.alert
Front.report
Front.confirm
Front.setPanelWidth
-Not implemented.