Skip to content

Commit

Permalink
docs: add link to presence spec in jsdoc
Browse files Browse the repository at this point in the history
Signed-off-by: Seth Falco <seth@falco.fun>
  • Loading branch information
SethFalco committed Oct 9, 2022
1 parent 99cd00a commit 9aa6663
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/models/events/PresenceEvent.ts
@@ -1,7 +1,12 @@
import { MatrixEvent } from "./Event";

/**
* The allowed states of presence in Matrix
* The allowed states of presence in Matrix.
*
* * `online`: The default state when the user is connected to an event stream.
* * `unavailable`: The user is not reachable at this time e.g. they are idle.
* * `offline`: The user is not connected to an event stream or is explicitly suppressing their profile information from being sent.
*
* @category Matrix event info
* @see PresenceEventContent
*/
Expand Down Expand Up @@ -30,6 +35,8 @@ export interface PresenceEventContent {

/**
* The user's presence state.
*
* @see {@link PresenceState} for a description of each presence key.
*/
presence: PresenceState;

Expand Down

0 comments on commit 9aa6663

Please sign in to comment.