ISessionListenerAddin

Add-in responsible for intercepting events over an artifact session.

Trigger Event(s): Session started, closed; Participant joined, left.

Table 1. *ISessionListenerAddin* interface methods declaration and description
Method	Description
sessionStarted
	Parameter	Type	Description
	itemId	String	Identifier of the item being accessed
	sessionType	String	Type of session being created

	Returns	Type	Description
	-	-	-
sessionClosed
	Parameter	Type	Description
	itemId	String	Identifier of the item being accessed
	sessionType	String	Type of session being created

	Returns	Type	Description
	-	-	-
participantJoined
	Parameter	Type	Description
	artifactDetails	ArtifactDetails	Artifact context with read-only access privileges
	sessionType	String	Type of session being joined

	Returns	Type	Description
	-	-	-
participantLeft
	Parameter	Type	Description
	artifactDetails	ArtifactDetails	Artifact context with read-only access privileges
	sessionType	String	Type of session being left

	Returns	Type	Description
	-	-	-

eSign brings an out-of-the box implementation for this interface that is described below

Table 2. Available implementations for ISessionListenerAddin
Implementation	Default	Description
DefaultSessionListenerAddin	✓	Does nothing

Configuration

First the add-in needs to be loaded as an extension,

"_comment" : "List all the extensions to be used",
"extensions" :
[
	...

	{
        "name": "session_listening",
        "class": "novabase.connect.paperless.esign.core.extensions.impl.DefaultSessionListenerAddin"
    },

	...
]

Optionally, set as the default add-in by establishing the class path for the type "session_listener"

"_comment" : "List all the default addins to be used",
"addins" :
[
    ...

    {
        "type": "session_listener",
        "extension": "session_listening"
    },

    ...
]