aboutsummaryrefslogtreecommitdiff
path: root/lib/dispatch.mli
blob: 0442c19664d1b375c1cb9c39e727e8e083331100 (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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
(** Used to store dispatch callbacks. Each event can only have one callback registered at a time.
    These should be accessed through their re-export in {!Client}.
    {3 Examples}
    [Client.ready := (fun _ -> print_endline "Shard is Ready!")]

    [Client.guild_create := (fun guild -> print_endline guild.name)]

    {[
        open Core
        open Disml

        let check_command (msg : Message.t) =
            if String.is_prefix ~prefix:"!ping" msg.content then
                Message.reply msg "Pong!" >>> ignore
        
        Client.message_create := check_command
    ]}
*)

(** Dispatched when connecting to the gateway, most users will have no use for this. *)
val hello : (Yojson.Safe.json -> unit) ref

(** Dispatched when each shard receives READY from discord after identifying on the gateway. Other event dispatch is received after this. *)
val ready : (Yojson.Safe.json -> unit) ref

(** Dispatched when successfully reconnecting to the gateway. *)
val resumed : (Yojson.Safe.json -> unit) ref

(** Dispatched when Discord decides a session is invalid, much like {!Client.hello} this is not very useful for most people. *)
val invalid_session : (Yojson.Safe.json -> unit) ref

(** Dispatched when a channel is created which is visible to the bot. *)
val channel_create : (Channel_t.t -> unit) ref

(** Dispatched when a channel visible to the bot is changed. *)
val channel_update : (Channel_t.t -> unit) ref

(** Dispatched when a channel visible to the bot is deleted. *)
val channel_delete : (Channel_t.t -> unit) ref

(** Dispatched when messages are pinned or unpinned from a a channel. *)
val channel_pins_update : (Yojson.Safe.json -> unit) ref

(** Dispatched when the bot joins a guild, and during startup. *)
val guild_create : (Guild_t.t -> unit) ref

(** Dispatched when a guild the bot is in is edited. *)
val guild_update : (Guild_t.t -> unit) ref

(** Dispatched when the bot is removed from a guild. *)
val guild_delete : (Guild_t.t -> unit) ref

(** Dispatched when a member is banned. *)
val member_ban : (Ban_t.t -> unit) ref

(** Dispatched when a member is unbanned. *)
val member_unban : (Ban_t.t -> unit) ref

(** Dispatched when emojis are added or removed from a guild. *)
val guild_emojis_update : (Yojson.Safe.json -> unit) ref

(** Dispatched when a guild's integrations are updated. *)
val integrations_update : (Yojson.Safe.json -> unit) ref

(** Dispatched when a member joins a guild. *)
val member_join : (Member_t.t -> unit) ref

(** Dispatched when a member leaves a guild. Is Dispatched alongside {!Client.member_ban} when a user is banned. *)
val member_leave : (Member_t.member_wrapper -> unit) ref

(** Dispatched when a member object is updated. *)
val member_update : (Member_t.member_update -> unit) ref

(** Dispatched when requesting guild members through {!Client.request_guild_members} *)
val members_chunk : (Member_t.t list -> unit) ref

(** Dispatched when a role is created. *)
val role_create : (Role_t.t -> unit) ref

(** Dispatched when a role is edited. *)
val role_update : (Role_t.t -> unit) ref

(** Dispatched when a role is deleted. *)
val role_delete : (Role_t.t -> unit) ref

(** Dispatched when a message is sent. *)
val message_create : (Message_t.t -> unit) ref

(** Dispatched when a message is edited. This does not necessarily mean the content changed. *)
val message_update : (Message_t.message_update -> unit) ref

(** Dispatched when a message is deleted. *)
val message_delete : (Snowflake.t -> Snowflake.t -> unit) ref

(** Dispatched when messages are bulk deleted. *)
val message_bulk_delete : (Snowflake.t list -> unit) ref

(** Dispatched when a rection is added to a message. *)
val reaction_add : (Reaction_t.reaction_event -> unit) ref

(** Dispatched when a reaction is removed from a message. *)
val reaction_remove : (Reaction_t.reaction_event -> unit) ref

(** Dispatched when all reactions are cleared from a message. *)
val reaction_bulk_remove : (Reaction_t.t list -> unit) ref

(** Dispatched when a user updates their presence. *)
val presence_update : (Presence.t -> unit) ref

(** Dispatched when a typing indicator is displayed. *)
val typing_start : (Yojson.Safe.json -> unit) ref

(** Dispatched when the current user is updated. You most likely want {!Client.member_update} or {!Client.presence_update} instead. *)
val user_update : (Yojson.Safe.json -> unit) ref

(**/**)
val voice_state_update : (Yojson.Safe.json -> unit) ref
val voice_server_update : (Yojson.Safe.json -> unit) ref
val webhooks_update : (Yojson.Safe.json -> unit) ref