Attendee Interface
A client within a Fluid session (period of container connectivity to service).
To use, import via @fluidframework/presence/beta.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
export interface Attendee<SpecificAttendeeId extends AttendeeId = AttendeeId>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| SpecificAttendeeId | AttendeeId | AttendeeId |
Remarks
Note: This is very preliminary attendee representation.
Attendee should be used as key to distinguish between different clients as they join, rejoin, and disconnect from a session. While a client's ClientConnectionId from getConnectionStatus() may change over time, Attendee will be fixed.
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| attendeeId | Beta |
readonly |
SpecificAttendeeId | The session ID of the client that is stable over all connections. |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| getConnectionId() | Beta |
ClientConnectionId | Get current client connection ID. |
| getConnectionStatus() | Beta |
AttendeeStatus | Get connection status of attendee. |
Property Details
attendeeId
The session ID of the client that is stable over all connections.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
readonly attendeeId: SpecificAttendeeId;
Type: SpecificAttendeeId
Method Details
getConnectionId
Get current client connection ID.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
getConnectionId(): ClientConnectionId;
Remarks
Connection ID will change on reconnect.
If getConnectionStatus() is (AttendeeStatus:variable).Disconnected, this will represent the last known connection ID.
Returns
Current client connection ID.
Return type: ClientConnectionId
getConnectionStatus
Get connection status of attendee.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
getConnectionStatus(): AttendeeStatus;
Returns
Connection status of attendee.
Return type: AttendeeStatus