IAudience Interface
Packages > fluid-framework > IAudience
Audience represents all clients connected to the op stream, both read-only and read/write.
Signature:
export interface IAudience extends EventEmitter
Extends:
Methods
| Method | Description |
|---|---|
| getMember(clientId) | Get details about the connected client with the specified clientId, or undefined if the specified client isn't connected |
| getMembers() | List all clients connected to the op stream, keyed off their clientId |
| on(event, listener) |
Methods
getMember
Get details about the connected client with the specified clientId, or undefined if the specified client isn’t connected
Signature:
getMember(clientId: string): IClient | undefined;
Parameters
| Parameter | Type | Description |
|---|---|---|
| clientId |
Returns:
getMembers
List all clients connected to the op stream, keyed off their clientId
Signature:
getMembers(): Map<string, IClient>;
Returns:
on
Signature:
on(event: "addMember" | "removeMember", listener: (clientId: string, client: IClient) => void): this;
Parameters
| Parameter | Type | Description |
|---|---|---|
| event | ||
| listener |
Returns: