Hiyve Components - v1.0.0
    Preparing search index...

    Function useConnection

    • Access connection state and room management actions.

      Provides the current connection status (connected, connecting, error) along with actions to create, join, and leave rooms.

      Returns {
          createRoom: (
              roomName: string,
              userId: string,
              options?: CreateRoomOptions,
          ) => Promise<void>;
          error: string | null;
          isConnected: boolean;
          isConnecting: boolean;
          joinRoom: (roomName: string, userId: string) => Promise<void>;
          leaveRoom: () => Promise<void>;
      }

      Object containing connection state (isConnected, isConnecting, error) and room management actions (createRoom, joinRoom, leaveRoom)

      • createRoom: (roomName: string, userId: string, options?: CreateRoomOptions) => Promise<void>
      • error: string | null
      • isConnected: boolean
      • isConnecting: boolean
      • joinRoom: (roomName: string, userId: string) => Promise<void>
      • leaveRoom: () => Promise<void>
      import { useConnection } from '@hiyve/rn-react';

      function JoinScreen() {
      const { isConnected, isConnecting, error, joinRoom, leaveRoom } = useConnection();

      if (isConnecting) return <ActivityIndicator />;
      if (error) return <Text>{error}</Text>;

      return (
      <Button
      title={isConnected ? 'Leave' : 'Join'}
      onPress={() => isConnected ? leaveRoom() : joinRoom({ roomName: 'my-room' })}
      />
      );
      }