clearRoomPasscode
expérimentaldepuis 0.1.0@legba-core/realtime
clearRoomPasscode
Ce que ça fait
Retire la protection par code d’une salle. Sans effet (no-op) si elle n’était pas protégée.
Signature
function clearRoomPasscode(roomService: RoomService, roomName: string): Promise<void>
Paramètres
| Nom | Type | Requis | Défaut | Description |
|---|---|---|---|---|
roomService | RoomService | oui | — | Instance de createRoomService |
roomName | string | oui | — | Doit désigner une salle existante |
Retour
Promise<void>.
Erreurs
| Code | Quand | Comment corriger |
|---|---|---|
LEGBA_INVALID_ROOM_REQUEST | roomName vide/blanc | Fournir un nom de salle valide |
LEGBA_ROOM_NOT_FOUND | La salle n’existe pas | Vérifier le nom de salle |
Exemple minimal
import { createRoomService, clearRoomPasscode } from "@legba-core/realtime";
const rooms = createRoomService({ serverUrl, apiKey, apiSecret });
await clearRoomPasscode(rooms, "salle-privee");
Exemple complet
Voir setRoomPasscode.
Pièges
- Ne retire que le hash de passcode : les autres métadonnées posées par
l’application (
topic, etc.) restent intactes. - Appeler sur une salle déjà non protégée n’est jamais une erreur.