Class EditingSessionContext

  • All Implemented Interfaces:
    ContextKeyManagerProvider

    @API(type=NOT_EXTENDABLE,
         src=PUBLIC)
    public abstract class EditingSessionContext
    extends java.lang.Object
    implements ContextKeyManagerProvider

    The editing session context.

    An editing session correspond to an user editing a document in the editor. Custom attributes can be registered from the API which can include information about the context of the editing, e.g. the user that performs the edit, the project in whose scope the editing session was started, etc.

    The session context is serializable and it serializes only the attributes whose value is serializable. The rest of the attributes are ignored.

    In Web Author, attributes can be added to the editing context by using:

  • URL parameters specified in the web brosers
  • JavaScript LoadingOptions set on the sync.api.Workspace.EventType.BEFORE_EDITOR_LOADED event handler.
  • The WebappEditingSessionLifecycleListener.editingSessionAboutToBeStarted(String, String, java.net.URL, java.util.Map) callback.
Since:
15.2