Add getSessionId function doc (#500)

jitsi · Mar 25, 2024 · 3ef84e0 · 3ef84e0
1 parent f577a40
commit 3ef84e0
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/dev-guide/iframe-functions.md b/docs/dev-guide/iframe-functions.md
@@ -182,6 +182,18 @@ Response example structure:
 }
 ```
 
+### getSessionId
+
+Returns the meting's unique Id (`sessionId`). 
+Please note that the `sessionId` is not available when in prejoin screen and it's not guaranteed to be available immediately after joining - in which cases it will be empty.
+
+```javascript
+api.getSessionId().then(sessionId => {
+    //sessionId: string
+    ...
+});
+```
+
 ### getVideoQuality
 
 Returns the current video quality setting.