Interface IChannelExposurePreferences

Where the user's per-channel exposure choices are kept.

interface IChannelExposurePreferences {
Get(channelKey: string): RealtimeChannelExposure | undefined;
Set(channelKey: string, level: RealtimeChannelExposure | undefined): void;
}

Implemented by

Index

Methods

Methods

Get

Get(channelKey: string): RealtimeChannelExposure | undefined
The user's choice for a channel (key matched case-insensitively), or undefined when they made none.
Parameters
- channelKey: string
Returns RealtimeChannelExposure | undefined
- Defined in session/channel-exposure-preferences.ts:31

Set

Set(channelKey: string, level: RealtimeChannelExposure | undefined): void
Records the user's choice for a channel. undefined clears it (back to "no choice").
Parameters
- channelKey: string
- level: RealtimeChannelExposure | undefined
Returns void
- Defined in session/channel-exposure-preferences.ts:33