aboutsummaryrefslogtreecommitdiff
path: root/lib/models/channel/channel.mli
blob: 001bb0552e969c45a126d160773533badbe30846 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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 *)