Table of Contents
Extend Session
Each Room is defined with duration value in minutes. This duration defines total length of single session and it’s counted from the time first user joins the session. EnableX drops the session when the session duration elapses.
For practical reasons, a session may need to get extended. Therefore, EnableX allows users to extend a session duration at run-time. Follow explanation given below:
- An “Extension Window” opens 10 minutes prior to the end of scheduled closure of the Session. All connected users are notified with an Event.
- Any user can trigger extension of the Session by calling a Method. If any user trigger extension, the Extension Window is closed. This prevents EnableX to process further Extension Request within the same Extension Window.
- If extension is not triggered by any user, another “Extension Window” opens 5 minutes prior to the end of scheduled closure of the Session. This is the final Extension Window. All connected users are notified with an Event.
- EnableX processes extension request and extends the session by 10 to 30 minutes. So, the extended period may vary.
- There is no cap on number of times you may extend your Session. Once extended, Step 1-4 will get repeated.
Method: public void extendConferenceDuration() – No parameter required
Callbacks:
onConferenceRemainingDuration– Notification to all when an Extension Window is open. It bring a JSON to show how many minutes is left to scheduled session closure.onConferencessExtended– Notification when Session is extended.
//Extend Request
room.extendConferenceDuration();
// Notifies that Session is scheduled to close in N Minutes
public void onConferenceRemainingDuration(JSONObject jsonObject) {
// Handle JSONObject
}
// Notifies that Session is extended
public void onConferencessExtended(JSONObject jsonObject) {
// Handle JSONObject
}
Destroy Session
The EnxRoom.destroy() method allows the Moderator to conclude an ongoing session.
Method: public void destroy() – No Parameter required.
Callbacks:
onAckDestroy– Acknowledgment to the Moderator when the session is destroyed.onRoomDisconnected -Notification to all users in the Room when the session is destroyed.
room.destroy();
// Moderator is acknowledged that session is destroyed
public void onAckDestroy(JSONObject jsonObject) {
// Handle JSONObject
}
Error Codes & Exceptions
| Code | Description |
|---|---|
| 5116 | Unauthorized Access. When a user with participant role invokes destroy(). |