aboutsummaryrefslogtreecommitdiff
path: root/lib/models/channel/message/message_t.mli
diff options
context:
space:
mode:
authorAdelyn Breedlove <[email protected]>2019-01-28 10:31:51 -0700
committerAdelyn Breedlove <[email protected]>2019-01-28 10:31:51 -0700
commit8662e92987c437f59d09896a247ec2b5d82c4528 (patch)
treef004cc14598351d4ad6b19d8e993d2f629c5e738 /lib/models/channel/message/message_t.mli
parentAdd more docs (diff)
downloaddisml-8662e92987c437f59d09896a247ec2b5d82c4528.tar.xz
disml-8662e92987c437f59d09896a247ec2b5d82c4528.zip
Publish docs updates
Diffstat (limited to 'lib/models/channel/message/message_t.mli')
-rw-r--r--lib/models/channel/message/message_t.mli42
1 files changed, 21 insertions, 21 deletions
diff --git a/lib/models/channel/message/message_t.mli b/lib/models/channel/message/message_t.mli
index 1f691b5..de56655 100644
--- a/lib/models/channel/message/message_t.mli
+++ b/lib/models/channel/message/message_t.mli
@@ -1,22 +1,22 @@
-(** Represents a message object. *)
-type t = {
- id: Message_id.t;
- author: User_t.t;
- channel_id: Channel_id_t.t;
- member: Member_t.partial_member option;
- guild_id: Guild_id_t.t option;
- content: string;
- timestamp: string;
- edited_timestamp: string option;
- tts: bool;
- mention_everyone: bool;
- mentions: User_t.t list;
- mention_roles: Role_id.t list;
- attachments: Attachment.t list;
- embeds: Embed.t list;
- reactions: Snowflake.t list;
- nonce: Snowflake.t option;
- pinned: bool;
- webhook_id: Snowflake.t option;
- kind: int;
+(** Represents a message object. *)
+type t = {
+ id: Message_id.t; (** Snowflake ID of the message. *)
+ author: User_t.t; (** User that authored the message. *)
+ channel_id: Channel_id_t.t; (** Channel ID the message exists in. *)
+ member: Member_t.partial_member option; (** A partial member if the message was sent in a guild. *)
+ guild_id: Guild_id_t.t option; (** Guild ID if the message was sent in a guild. *)
+ content: string; (** Content of the message. *)
+ timestamp: string; (** ISO8601 timestamp of when the message was created. *)
+ edited_timestamp: string option; (** Like timestamp, but for last edit, if any. *)
+ tts: bool; (** Whether the message used text-to-speech. *)
+ mention_everyone: bool; (** Whether the message mentioned [@everyone] or [@here] *)
+ mentions: User_t.t list; (** A List of users that were mentioned in the message. *)
+ mention_roles: Role_id.t list; (** A list of roles that were mentioned in the message. *)
+ attachments: Attachment.t list; (** A list of attachments. *)
+ embeds: Embed.t list; (** A List of embeds on the message. *)
+ reactions: Snowflake.t list; (** A list of reactions. *)
+ nonce: Snowflake.t option; (** Used in verification, safe to ignore. *)
+ pinned: bool; (** Whether the message is pinned. *)
+ webhook_id: Snowflake.t option; (** The webhook ID, if the message was sent by a webhook. *)
+ kind: int; (** See {{:https://discordapp.com/developers/docs/resources/channel#message-object-message-types}the discord docs} for message type enumeration. *)
} [@@deriving sexp, yojson] \ No newline at end of file