For documentation on the current version, please check Knowledge Base.
Notes on migrating from 10.5 to 11.1
This page highlights the most important API changes when migrating from the 10.5 to 11.1 APIs.
Events
Some events were removed :
- ClientEvent.LOAD_PUBLICATION_LIST_FAILURE → LoadPublicationListEvent.FAILURE
- ClientEvent.LOAD_PUBLICATION_LIST_SUCCESS → LoadPublicationListEvent.SUCCESS
They are not needed anymore, use of the component's own login management is recommended.
Login management
Starting from version 11.1, login management is handled by the webclient component itself. This means that login panels should be removed from the host application and you should just let the user use the webclient's login panel provided by the component. The login panel appears automatically, after license activation.
The new login panel allows the user to :
- Remember his last login (url, username, password)
- Auto-login (on next launch)
- Keep track of recent connections
By default, the component uses the Flash Local Storage (aka. flash cookies) to save the login configuration.
You can also choose to take control of saving the login configuration data. You can store it where you see fit, for example in a file on disk. New functions were added to the API to make this possible :
- The
getLoginConfiguration()function - The
setLoginConfiguration()function - The
loginConfigurationChangedevent.
Example : Manage login configuration data
The toolbar button for opening the Login Settings can be replaced by the following API call that will present the webclient login panel to the user :
- The
showLoginPanel()function
Loading a Publication
Loading a publication can still be done directly using the loadPublication() function, but will most likely be done by the user itself from the new login panel. When a publication is loaded and you want the old behaviour back where the startup parameters are not applied, you can now use a global setting :
setSetting("ApplyStartupParametersOnLoad","false")