added example

100mslive · Jul 24, 2024 · 81b74bb · 81b74bb
1 parent 99f41f7
commit 81b74bb
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/packages/react-native-hms/src/classes/HMSUpdateListenerActions.ts b/packages/react-native-hms/src/classes/HMSUpdateListenerActions.ts
@@ -9,6 +9,15 @@
  *
  * @enum {string}
  *
+ * @example
+ * ```typescript
+ * import { HMSUpdateListenerActions } from 'react-native-hms';
+ * hmsinstance.on(HMSUpdateListenerActions.ON_JOIN, ({ room: HMSRoom }}) => {
+ *  console.log('Joined room', data);
+ *  // Handle the event
+ * });
+ * ```
+ *
  * @property {string} ON_PREVIEW - Emitted when the local preview is available.
  * @property {string} ON_JOIN - Emitted when the local user joins the room.
  * @property {string} ON_ROOM_UPDATE - Emitted when there is an update related to the room.