Group

class Group

A class which represents a Group.

Constructors

Link copied to clipboard
fun Group(groupId: Int)

Creates a new Group objected provided the group ID of the Group.

Functions

Link copied to clipboard
fun exileUser(user: User)

fun exileUser(userId: Long)

Method to exile a user provided the user's ID

Link copied to clipboard
fun getRole(roleNumber: Int): GroupRole

Method to get a specific Group role provided the role's rank or roleset ID

fun getRole(roleName: String): GroupRole

Method to get a specific Group role provided the role's name.

Link copied to clipboard
fun getRoles(): List<GroupRole>

Method to get the Group's roles.

Link copied to clipboard
fun getUserRank(user: User): GroupRole

fun getUserRank(userId: Long): GroupRole

Method to get the rank of a User in a group provided a User ID

Link copied to clipboard
fun rankUser(user: User, roleNumber: Int)

fun rankUser(userId: Long, roleNumber: Int)

Method to set the rank of a user in a group provided both the user's ID and the role's rank or roleset ID

Link copied to clipboard
fun setClient(client: RoavaClient)

Method to set the Group's RoavaClient for authentication purposes.

Properties

Link copied to clipboard
val description: String
Link copied to clipboard
val id: Int
Link copied to clipboard
val memberCount: Int
Link copied to clipboard
val name: String
Link copied to clipboard
val owner: User