Add participantRoleChanged event to external API (#6573)

* Add participantRoleChanged event to external API * Update API documentation * Remove unneeded whitespace * Remove more unneeded whitespace * Fix jsdoc formatting * Fix jsdoc formatting
2020-05-05 09:03:54 -05:00
parent a18fd1cdb3
commit acbf641fb4
6 changed files with 44 additions and 0 deletions
@@ -439,6 +439,22 @@ class API {
        });
    }

+    /**
+     * Notify external application (if API is enabled) that the user role
+     * has changed.
+     *
+     * @param {string} id - User id.
+     * @param {string} role - The new user role.
+     * @returns {void}
+     */
+    notifyUserRoleChanged(id: string, role: string) {
+        this._sendEvent({
+            name: 'participant-role-changed',
+            id,
+            role
+        });
+    }
+
    /**
     * Notify external application (if API is enabled) that user changed their
     * avatar.