aboutsummaryrefslogtreecommitdiff
path: root/lib/models/user/presence.mli
diff options
context:
space:
mode:
Diffstat (limited to 'lib/models/user/presence.mli')
-rw-r--r--lib/models/user/presence.mli13
1 files changed, 7 insertions, 6 deletions
diff --git a/lib/models/user/presence.mli b/lib/models/user/presence.mli
index 13c8cf0..6c60d7f 100644
--- a/lib/models/user/presence.mli
+++ b/lib/models/user/presence.mli
@@ -1,8 +1,9 @@
+(** A user presence. *)
type t = {
- user: User_t.partial_user;
- roles: Role_id.t list;
- game: Activity.t option;
- guild_id: Guild_id_t.t;
- status: string;
- activities: Activity.t list;
+ user: User_t.partial_user; (** A partial user that this presence belongs to. *)
+ roles: Role_id.t list; (** A list of roles that the user has. *)
+ game: Activity.t option; (** The current activity of the user, if any. *)
+ guild_id: Guild_id_t.t; (** The guild ID in which this presence exists. *)
+ status: string; (** One of [online], [idle], [offline], or [dnd]. *)
+ activities: Activity.t list; (** A list of all of the user's current activities. *)
} [@@deriving sexp, yojson] \ No newline at end of file