From 8662e92987c437f59d09896a247ec2b5d82c4528 Mon Sep 17 00:00:00 2001 From: Adelyn Breedlove Date: Mon, 28 Jan 2019 10:31:51 -0700 Subject: Publish docs updates --- lib/event.mli | 96 +++++++++++++++++++++++++++++------------------------------ 1 file changed, 48 insertions(+), 48 deletions(-) (limited to 'lib/event.mli') diff --git a/lib/event.mli b/lib/event.mli index 9e05569..d4a539b 100644 --- a/lib/event.mli +++ b/lib/event.mli @@ -1,49 +1,49 @@ -(** Barebones of event dispatching. Most users will have no reason to look here. *) - -open Event_models - -(** Event dispatch type wrapper. Used internally. *) -type t = -| READY of Ready.t -| RESUMED of Resumed.t -| CHANNEL_CREATE of ChannelCreate.t -| CHANNEL_UPDATE of ChannelUpdate.t -| CHANNEL_DELETE of ChannelDelete.t -| CHANNEL_PINS_UPDATE of ChannelPinsUpdate.t -| GUILD_CREATE of GuildCreate.t -| GUILD_UPDATE of GuildUpdate.t -| GUILD_DELETE of GuildDelete.t -| GUILD_BAN_ADD of GuildBanAdd.t -| GUILD_BAN_REMOVE of GuildBanRemove.t -| GUILD_EMOJIS_UPDATE of GuildEmojisUpdate.t -(* | GUILD_INTEGRATIONS_UPDATE of Yojson.Safe.json *) -| GUILD_MEMBER_ADD of GuildMemberAdd.t -| GUILD_MEMBER_REMOVE of GuildMemberRemove.t -| GUILD_MEMBER_UPDATE of GuildMemberUpdate.t -| GUILD_MEMBERS_CHUNK of GuildMembersChunk.t -| GUILD_ROLE_CREATE of GuildRoleCreate.t -| GUILD_ROLE_UPDATE of GuildRoleUpdate.t -| GUILD_ROLE_DELETE of GuildRoleDelete.t -| MESSAGE_CREATE of MessageCreate.t -| MESSAGE_UPDATE of MessageUpdate.t -| MESSAGE_DELETE of MessageDelete.t -| MESSAGE_DELETE_BULK of MessageDeleteBulk.t -| REACTION_ADD of ReactionAdd.t -| REACTION_REMOVE of ReactionRemove.t -| REACTION_REMOVE_ALL of ReactionRemoveAll.t -| PRESENCE_UPDATE of PresenceUpdate.t -| TYPING_START of TypingStart.t -| USER_UPDATE of UserUpdate.t -(* | VOICE_STATE_UPDATE of Yojson.Safe.json *) -(* | VOICE_SERVER_UPDATE of Yojson.Safe.json *) -| WEBHOOK_UPDATE of WebhookUpdate.t -| UNKNOWN of Unknown.t - -(** Used to convert an event string and payload into a t wrapper type. *) -val event_of_yojson : contents:Yojson.Safe.json -> string -> t - -(** Sends the event to the registered handler. *) -val dispatch : t -> unit - -(** Wrapper to other functions. This is called from the shards. *) +(** Barebones of event dispatching. Most users will have no reason to look here. *) + +open Event_models + +(** Event dispatch type wrapper. Used internally. *) +type t = +| READY of Ready.t +| RESUMED of Resumed.t +| CHANNEL_CREATE of ChannelCreate.t +| CHANNEL_UPDATE of ChannelUpdate.t +| CHANNEL_DELETE of ChannelDelete.t +| CHANNEL_PINS_UPDATE of ChannelPinsUpdate.t +| GUILD_CREATE of GuildCreate.t +| GUILD_UPDATE of GuildUpdate.t +| GUILD_DELETE of GuildDelete.t +| GUILD_BAN_ADD of GuildBanAdd.t +| GUILD_BAN_REMOVE of GuildBanRemove.t +| GUILD_EMOJIS_UPDATE of GuildEmojisUpdate.t +(* | GUILD_INTEGRATIONS_UPDATE of Yojson.Safe.json *) +| GUILD_MEMBER_ADD of GuildMemberAdd.t +| GUILD_MEMBER_REMOVE of GuildMemberRemove.t +| GUILD_MEMBER_UPDATE of GuildMemberUpdate.t +| GUILD_MEMBERS_CHUNK of GuildMembersChunk.t +| GUILD_ROLE_CREATE of GuildRoleCreate.t +| GUILD_ROLE_UPDATE of GuildRoleUpdate.t +| GUILD_ROLE_DELETE of GuildRoleDelete.t +| MESSAGE_CREATE of MessageCreate.t +| MESSAGE_UPDATE of MessageUpdate.t +| MESSAGE_DELETE of MessageDelete.t +| MESSAGE_DELETE_BULK of MessageDeleteBulk.t +| REACTION_ADD of ReactionAdd.t +| REACTION_REMOVE of ReactionRemove.t +| REACTION_REMOVE_ALL of ReactionRemoveAll.t +| PRESENCE_UPDATE of PresenceUpdate.t +| TYPING_START of TypingStart.t +| USER_UPDATE of UserUpdate.t +(* | VOICE_STATE_UPDATE of Yojson.Safe.json *) +(* | VOICE_SERVER_UPDATE of Yojson.Safe.json *) +| WEBHOOK_UPDATE of WebhookUpdate.t +| UNKNOWN of Unknown.t + +(** Used to convert an event string and payload into a t wrapper type. *) +val event_of_yojson : contents:Yojson.Safe.json -> string -> t + +(** Sends the event to the registered handler. *) +val dispatch : t -> unit + +(** Wrapper to other functions. This is called from the shards. *) val handle_event : ev:string -> Yojson.Safe.json -> unit \ No newline at end of file -- cgit v1.2.3