aboutsummaryrefslogtreecommitdiff
path: root/lib/models/guild/member.mli
blob: 76cb2dea54de245aa57942e7f0f99e79ce26645d (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
include module type of Member_t

(** Adds a role to the member. *)
val add_role : role:Role_t.t -> Member_t.t -> (unit, string) Lwt_result.t

(** Removes a role from the member. *)
val remove_role : role:Role_t.t -> Member_t.t -> (unit, string) Lwt_result.t

(** Bans the member with optional reason and days of messages to delete. *)
val ban : ?reason:string -> ?days:int -> Member_t.t -> (unit, string) Lwt_result.t

(** Kicks the member with the optional reason. *)
val kick : ?reason:string -> Member_t.t -> (unit, string) Lwt_result.t

(** Mutes the member, preventing them from speaking in voice chats. *)
val mute : Member_t.t -> (unit, string) Lwt_result.t

(** Deafens the member, preventing them from hearing others in voice chats. *)
val deafen : Member_t.t -> (unit, string) Lwt_result.t

(** Opposite of {!mute}. *)
val unmute : Member_t.t -> (unit, string) Lwt_result.t

(** Opposite of {!deafen}. *)
val undeafen : Member_t.t -> (unit, string) Lwt_result.t