useParticipantPermissions
function useParticipantPermissions(_options?):
| ParticipantPermission
| undefined;Defined in: packages/react/src/hooks/participant/useParticipantPermissions.ts:44
A reactive React primitive.
Parameters
| Parameter | Type |
|---|---|
_options? | UseParticipantPermissionsOptions |
Returns
| ParticipantPermission
| undefined
Example
// Basic — read permissions from participant context.
const permissions = useParticipantPermissions();
// Advanced — branch controls on whether permissions are present.
function PermissionGate({ participant }: { participant: Participant }) {
const permissions = useParticipantPermissions({ participant });
const { identity } = useParticipantInfo({ participant });
return <button disabled={!permissions}>Moderate {identity}</button>;
}
function Roster() {
const participants = useParticipants();
return <>{participants.map((participant) => <PermissionGate key={participant.identity} participant={participant} />)}</>;
}
function App() {
return <VoiceRoom agent={agent}><Roster /></VoiceRoom>;
}