diff options
| author | Adelyn Breelove <[email protected]> | 2019-01-28 09:48:49 -0700 |
|---|---|---|
| committer | Adelyn Breelove <[email protected]> | 2019-01-28 09:48:49 -0700 |
| commit | f43c41dcf56a30f3fac0de07349b2c505203c380 (patch) | |
| tree | 2d2e228a2dd1cd489927cfec547494a433bded42 /lib/models/guild/member.mli | |
| parent | Fix Message.t.mentions (diff) | |
| download | disml-f43c41dcf56a30f3fac0de07349b2c505203c380.tar.xz disml-f43c41dcf56a30f3fac0de07349b2c505203c380.zip | |
Add more docs
Diffstat (limited to 'lib/models/guild/member.mli')
| -rw-r--r-- | lib/models/guild/member.mli | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/models/guild/member.mli b/lib/models/guild/member.mli index 3ac786c..a3acc1b 100644 --- a/lib/models/guild/member.mli +++ b/lib/models/guild/member.mli @@ -2,11 +2,26 @@ open Async include module type of Member_t +(** Adds a role to the member. *) val add_role : role:Role_t.t -> Member_t.t -> unit Deferred.Or_error.t + +(** Removes a role from the member. *) val remove_role : role:Role_t.t -> Member_t.t -> unit Deferred.Or_error.t + +(** Bans the member with optional reason and days of messages to delete. *) val ban : ?reason:string -> ?days:int -> Member_t.t -> unit Deferred.Or_error.t + +(** Kicks the member with the optional reason. *) val kick : ?reason:string -> Member_t.t -> unit Deferred.Or_error.t + +(** Mutes the member, preventing them from speaking in voice chats. *) val mute : Member_t.t -> unit Deferred.Or_error.t + +(** Deafens the member, preventing them from hearing others in voice chats. *) val deafen : Member_t.t -> unit Deferred.Or_error.t + +(** Opposite of {!mute}. *) val unmute : Member_t.t -> unit Deferred.Or_error.t + +(** Opposite of {!deafen}. *) val undeafen : Member_t.t -> unit Deferred.Or_error.t
\ No newline at end of file |