aboutsummaryrefslogtreecommitdiff
path: root/lib/models/channel
diff options
context:
space:
mode:
Diffstat (limited to 'lib/models/channel')
-rw-r--r--lib/models/channel/channel.ml56
-rw-r--r--lib/models/channel/channel.mli45
-rw-r--r--lib/models/channel/channel_t.mli7
-rw-r--r--lib/models/channel/message/embed.mli49
-rw-r--r--lib/models/channel/message/message_t.mli2
-rw-r--r--lib/models/channel/message/reaction_t.mli2
6 files changed, 63 insertions, 98 deletions
diff --git a/lib/models/channel/channel.ml b/lib/models/channel/channel.ml
index 972f888..68b3a97 100644
--- a/lib/models/channel/channel.ml
+++ b/lib/models/channel/channel.ml
@@ -1,57 +1,3 @@
-open Async
-open Core
include Channel_t
-exception Invalid_message
-exception No_message_found
-
-let say ~content ch =
- Http.create_message (get_id ch) (`Assoc [("content", `String content)])
- >>| Result.map ~f:Message_t.of_yojson_exn
-
-let send_message ?embed ?content ?file ?(tts=false) ch =
- let embed = match embed with
- | Some e -> Embed.to_yojson e
- | None -> `Null in
- let content = match content with
- | Some c -> `String c
- | None -> `Null in
- let file = match file with
- | Some f -> `String f
- | None -> `Null in
- let () = match embed, content with
- | `Null, `Null -> raise Invalid_message
- | _ -> () in
- Http.create_message (get_id ch) (`Assoc [
- ("embed", embed);
- ("content", content);
- ("file", file);
- ("tts", `Bool tts);
- ]) >>| Result.map ~f:Message_t.of_yojson_exn
-
-let delete ch =
- Http.delete_channel (get_id ch) >>| Result.map ~f:ignore
-
-let get_message ~id ch =
- Http.get_message (get_id ch) id >>| Result.map ~f:Message_t.of_yojson_exn
-
-let get_messages ?(mode=`Around) ?id ?(limit=50) ch =
- let kind = match mode with
- | `Around -> "around", limit
- | `Before -> "before", limit
- | `After -> "after", limit
- in
- let id = match id with
- | Some id -> id
- | None -> raise No_message_found in
- Http.get_messages (get_id ch) id kind >>| Result.map ~f:(fun l ->
- Yojson.Safe.Util.to_list l
- |> List.map ~f:Message_t.of_yojson_exn)
-
-let broadcast_typing ch =
- Http.broadcast_typing (get_id ch) >>| Result.map ~f:ignore
-
-let get_pins ch =
- Http.get_pinned_messages (get_id ch) >>| Result.map ~f:(fun l ->
- Yojson.Safe.Util.to_list l
- |> List.map ~f:Message_t.of_yojson_exn) \ No newline at end of file
+include Impl.Channel(Channel_t) \ No newline at end of file
diff --git a/lib/models/channel/channel.mli b/lib/models/channel/channel.mli
index 001bb05..feb7323 100644
--- a/lib/models/channel/channel.mli
+++ b/lib/models/channel/channel.mli
@@ -1,44 +1,3 @@
-open Async
include module type of Channel_t
-
-exception Invalid_message
-exception No_message_found
-
-(** Simple version of send_message that only takes [~content] *)
-val say : content:string -> t -> Message_t.t Deferred.Or_error.t
-
-(** Advanced message sending.
-
- Raises {!Channel.Invalid_message} if one of content or embed is not set.
-
- {3 Examples}
- {[
- open Core
- open Disml
-
- let check_command (msg : Message.t) =
- if String.is_prefix ~prefix:"!hello" msg.content then
- let embed = { Embed.default with title = Some "Hello World!" } in
- Channel.send_message ~embed msg.channel >>> ignore
-
- Client.message_create := check_command
- ]}
-*)
-val send_message :
- ?embed:Embed.t ->
- ?content:string ->
- ?file:string ->
- ?tts:bool ->
- t ->
- Message_t.t Deferred.Or_error.t
-val delete : t -> unit Deferred.Or_error.t
-val get_message : id:Snowflake.t -> t -> Message_t.t Deferred.Or_error.t
-val get_messages :
- ?mode:[ `Before | `After | `Around ] ->
- ?id:Snowflake.t ->
- ?limit:int ->
- t ->
- Message_t.t list Deferred.Or_error.t
-val broadcast_typing : t -> unit Deferred.Or_error.t
-val get_pins : t -> Message_t.t list Deferred.Or_error.t
-(* TODO more things related to guild channels *) \ No newline at end of file
+include S.ChannelImpl with
+ type t := Channel_t.t \ No newline at end of file
diff --git a/lib/models/channel/channel_t.mli b/lib/models/channel/channel_t.mli
index 2ac66fb..f3974d4 100644
--- a/lib/models/channel/channel_t.mli
+++ b/lib/models/channel/channel_t.mli
@@ -1,5 +1,6 @@
exception Invalid_channel of Yojson.Safe.json
+(** Represents a Group channel object. *)
type group = {
id: Snowflake.t;
last_message_id: Snowflake.t option;
@@ -10,12 +11,14 @@ type group = {
recipients: User_t.t list;
} [@@deriving sexp, yojson]
+(** Represents a private channel with a single user. *)
type dm = {
id: Snowflake.t;
last_message_id: Snowflake.t option;
last_pin_timestamp: string option;
} [@@deriving sexp, yojson]
+(** Represents a text channel in a guild. *)
type guild_text = {
id: Snowflake.t;
last_message_id: Snowflake.t option;
@@ -29,6 +32,7 @@ type guild_text = {
slow_mode_timeout: int option;
} [@@deriving sexp, yojson]
+(** Represents a voice channel in a guild. *)
type guild_voice = {
id: Snowflake.t;
category_id: Snowflake.t option;
@@ -39,6 +43,7 @@ type guild_voice = {
bitrate: int option;
} [@@deriving sexp, yojson]
+(** Represents a guild category. *)
type category = {
id: Snowflake.t;
guild_id: Snowflake.t option;
@@ -46,6 +51,7 @@ type category = {
name: string;
} [@@deriving sexp, yojson]
+(** Wrapper variant for all channel types. *)
type t =
| Group of group
| Private of dm
@@ -54,6 +60,7 @@ type t =
| Category of category
[@@deriving sexp, yojson]
+(** Intermediate used internally. *)
type channel_wrapper = {
id: Snowflake.t;
kind: int;
diff --git a/lib/models/channel/message/embed.mli b/lib/models/channel/message/embed.mli
index d15c9fd..411d8cc 100644
--- a/lib/models/channel/message/embed.mli
+++ b/lib/models/channel/message/embed.mli
@@ -1,9 +1,11 @@
+(** A footer object belonging to an embed. *)
type footer = {
text: string;
icon_url: string option;
proxy_icon_url: string option;
} [@@deriving sexp, yojson]
+(** An image object belonging to an embed. *)
type image = {
url: string option;
proxy_url: string option;
@@ -11,17 +13,20 @@ type image = {
width: int option;
} [@@deriving sexp, yojson]
+(** A video object belonging to an embed. *)
type video = {
url: string option;
height: int option;
width: int option;
} [@@deriving sexp, yojson]
+(** A provider object belonging to an embed. *)
type provider = {
name: string option;
url: string option;
} [@@deriving sexp, yojson]
+(** An author object belonging to an embed. *)
type author = {
name: string option;
url: string option;
@@ -29,12 +34,14 @@ type author = {
proxy_icon_url: string option;
} [@@deriving sexp, yojson]
+(** A field object belonging to an embed. *)
type field = {
name: string;
value: string;
inline: bool;
} [@@deriving sexp, yojson]
+(** An embed object. See this {{:https://leovoel.github.io/embed-visualizer/}embed visualiser} if you need help understanding each component. *)
type t = {
title: string option;
kind: string option[@key "type"];
@@ -51,29 +58,71 @@ type t = {
fields: field list [@default []];
} [@@deriving sexp, yojson { strict = false }]
+(** An embed where all values are empty. *)
val default : t
+
+(** A footer where all values are empty. *)
val default_footer : footer
+
+(** An image where all values are empty. *)
val default_image : image
+
+(** A video where all values are empty. *)
val default_video : video
+
+(** A provider where all values are empty. *)
val default_provider : provider
+
+(** An author where all values are empty. *)
val default_author : author
+(** Set the title of an embed. *)
val title : string -> t -> t
+
+(** Set the description of an embed. *)
val description : string -> t -> t
+
+(** Set the URL of an embed. *)
val url : string -> t -> t
+
+(** Set the timestamp of an embed. *)
val timestamp : string -> t -> t
+
+(** Set the colour of an embed. *)
val colour : int -> t -> t
+
+(** Identical to {!colour} but with US English spelling. *)
val color : int -> t -> t
+
+(** Set the footer of an embed. The function passes {!default_footer} and must return a footer. *)
val footer : (footer -> footer) -> t -> t
+
+(** Set the image URL of an embed. *)
val image : string -> t -> t
+
+(** Set the thumbnail URL of an embed. *)
val thumbnail : string -> t -> t
+
+(** Set the author of an embed. The function passes {!default_author} and must return an author. *)
val author : (author -> author) -> t -> t
+
+(** Add a field to an embed. Takes a tuple in [(name, value, inline)] order. {b Fields added this way will appear in reverse order in the embed.} *)
val field : string * string * bool -> t -> t
+
+(** Set the fields of an embed. Similar to {!val:field}, but because a complete list is passed, fields preserve order. *)
val fields : (string * string * bool) list -> t -> t
+(** Set the footer text. Typically used in the closure passed to {!val:footer}. *)
val footer_text : string -> footer -> footer
+
+(** Set the footer icon URL. Typically used in the closure passed to {!val:footer}. *)
val footer_icon : string -> footer -> footer
+(** Set the author name. Typically used in the closure passed to {!val:author}. *)
val author_name : string -> author -> author
+
+(** Set the author URL. Typically used in the closure passed to {!val:author}. *)
val author_url : string -> author -> author
+
+(** Set the author icon URL. Typically used in the closure passed to {!val:author}. *)
val author_icon : string -> author -> author \ No newline at end of file
diff --git a/lib/models/channel/message/message_t.mli b/lib/models/channel/message/message_t.mli
index 20360e8..097a705 100644
--- a/lib/models/channel/message/message_t.mli
+++ b/lib/models/channel/message/message_t.mli
@@ -1,3 +1,4 @@
+(** Represents data sent on {{!Dispatch.member_update}member update} events. *)
type message_update = {
id: Snowflake.t;
author: User_t.t option;
@@ -20,6 +21,7 @@ type message_update = {
kind: int option;
} [@@deriving sexp, yojson]
+(** Represents a message object. *)
type t = {
id: Snowflake.t;
author: User_t.t;
diff --git a/lib/models/channel/message/reaction_t.mli b/lib/models/channel/message/reaction_t.mli
index 5bdd275..db95521 100644
--- a/lib/models/channel/message/reaction_t.mli
+++ b/lib/models/channel/message/reaction_t.mli
@@ -1,3 +1,4 @@
+(** Represents a single reaction as received over the gateway. *)
type reaction_event = {
user_id: Snowflake.t;
channel_id: Snowflake.t;
@@ -6,6 +7,7 @@ type reaction_event = {
emoji: Emoji.partial_emoji;
} [@@deriving sexp, yojson]
+(** Represents a number of emojis used as a reaction on a message. *)
type t = {
count: int;
emoji: Emoji.t;
generated by cgit v1.2.3 (git 2.25.1) at 2026-05-16 16:28:58 +0000