Details
-
Type:
Improvement
-
Status: Closed
-
Priority:
Minor
-
Resolution: Fixed
-
Affects Version/s: EE-1.8.2.GA_P03
-
Fix Version/s: EE-1.8.2.GA_P07
-
Component/s: Documentation
-
Labels:None
-
Environment:Ajax Push Documentation
-
Assignee Priority:P1
-
Affects:Documentation (User Guide, Ref. Guide, etc.)
Description
The current 1.8 documentation on using Ajax Push APIs (http://res.icesoft.org/docs/v1_8_2/htmlguide/devguide/AdvancedTopics2.html#1075177) covers the 3 available approaches:
* PersistentFacesState - the low-level API not generally recommended for direct use by developers (requires creation and use of their own thread)
* RenderManager API - the initial public API
* SessionRenderer API - the later, simpler API
While the documentation encourages using the RenderManager and SessionManager APIs rather than the PersistentFacesState directly, it doesn't expressly declare not to use the PersistentFaceState. From a support perspective, it's desirable that we more clearly define the recommend usage and best practices.
* PersistentFacesState - the low-level API not generally recommended for direct use by developers (requires creation and use of their own thread)
* RenderManager API - the initial public API
* SessionRenderer API - the later, simpler API
While the documentation encourages using the RenderManager and SessionManager APIs rather than the PersistentFacesState directly, it doesn't expressly declare not to use the PersistentFaceState. From a support perspective, it's desirable that we more clearly define the recommend usage and best practices.
Activity
- All
- Comments
- History
- Activity
- Remote Attachments
- Subversion
Added the change to the P07 tag as well us updating the online document to include a note that aligns with the new JavaDoc, stating that the PersistentFacesState is not the supported API for using Ajax Push.
Show
Deryk Sinotte
added a comment - Added the change to the P07 tag as well us updating the online document to include a note that aligns with the new JavaDoc, stating that the PersistentFacesState is not the supported API for using Ajax Push.
Added API notes to the class and relevant methods explaining that it's not the supported mechanism for doing Ajax Push and link them to the online documentation and the supported API classes (SessionRenderer and RenderManager).