isRoomProtected

expérimentaldepuis 0.1.0@legba-core/realtime

isRoomProtected

Ce que ça fait

Indique si des métadonnées de salle portent un code d’accès — dérivé de la présence du hash, jamais du code lui-même.

Signature

function isRoomProtected(metadata: Record<string, unknown>): boolean

Paramètres

NomTypeRequisDéfautDescription
metadataRecord<string, unknown>ouiTypiquement le retour de RoomService.getRoomMetadata

Retour

booleantrue si un hash de passcode est présent.

Erreurs

N/A — fonction pure, aucun appel réseau.

Exemple minimal

import { createRoomService, isRoomProtected } from "@legba-core/realtime";

const rooms = createRoomService({ serverUrl, apiKey, apiSecret });
const metadata = await rooms.getRoomMetadata("salle-demo");

if (isRoomProtected(metadata)) {
  // afficher un cadenas dans l'interface
}

Exemple complet

Voir setRoomPasscode.

Pièges

  • N’inspecte que l’objet metadata fourni — appeler RoomService.getRoomMetadata d’abord pour obtenir des métadonnées à jour (jamais un cache local).

Voir aussi