aboutsummaryrefslogtreecommitdiff
path: root/lib/models/guild/role.mli
blob: 70474a6311f608f241f24dc80b30e11fd9d26d1d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
include module type of Role_t

(** Deletes the role. This is permanent. *)
val delete : t -> (unit, string) Lwt_result.t

(** Edits the role to allow mentions. *)
val allow_mention : t -> (t, string) Lwt_result.t

(** Opposite of {!allow_mention} *)
val disallow_mention : t -> (t, string) Lwt_result.t

(** Hoists the role. See {!Role.t.hoist}. *)
val hoist : t -> (t, string) Lwt_result.t

(** Opposite of {!hoist}. *)
val unhoist : t -> (t, string) Lwt_result.t

(** Sets the colour of the role. *)
val set_colour : colour:int -> t -> (t, string) Lwt_result.t

(** Sets the name of the role. *)
val set_name : name:string -> t -> (t, string) Lwt_result.t