groups
AsyncGroup
Bases: BaseModel
A user group.
gid
instance-attribute
members
property
The users in this group.
model_config = ConfigDict(arbitrary_types_allowed=True)
class-attribute
instance-attribute
name
instance-attribute
add(users)
async
Add users to the group.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
users
|
Union[List[str], List[AsyncUser]]
|
The usernames to add |
required |
remove(users)
async
Remove users from the group.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
users
|
Union[List[str], List[AsyncUser]]
|
The usernames to remove |
required |
update()
async
Update the state of the group by fetching the state from the server.
AsyncGroupMember
A group member.