From 9aa66635c45490c87f33ad5375e39bc5982b9ae5 Mon Sep 17 00:00:00 2001 From: Seth Falco Date: Sat, 8 Oct 2022 22:41:51 +0100 Subject: [PATCH] docs: add link to presence spec in jsdoc Signed-off-by: Seth Falco --- src/models/events/PresenceEvent.ts | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/models/events/PresenceEvent.ts b/src/models/events/PresenceEvent.ts index a5bf0d1c..a88408ce 100644 --- a/src/models/events/PresenceEvent.ts +++ b/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 */ @@ -30,6 +35,8 @@ export interface PresenceEventContent { /** * The user's presence state. + * + * @see {@link PresenceState} for a description of each presence key. */ presence: PresenceState;