Skip to main content

OdspMember Interface

Since ODSP provides user names and email for all of its members, we extend the IMember interface to include this service-specific value. It will be returned for all audience members connected.

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/odsp-client/beta.

For more information about our API support guarantees, see here.

Signature​

export interface OdspMember extends IMember

Extends: IMember

Properties​

PropertyAlertsTypeDescription
emailBetastringThe user's email
idBetastringThe object ID (oid) for the user, unique among each individual user connecting to the session.
nameBetastringThe user's name

Property Details​

email​

The user's email

This API is provided as a beta preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

email: string;

Type: string

id​

The object ID (oid) for the user, unique among each individual user connecting to the session.

This API is provided as a beta preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

id: string;

Type: string

name​

The user's name

This API is provided as a beta preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

name: string;

Type: string