Struct Groups 

pub struct Groups<'a> { /* private fields */ }

Implementations

impl<'a> Groups<'a>

pub async fn query_info(&self, jid: &Jid) -> Result<GroupInfo, Error>

pub async fn get_participating( &self, ) -> Result<HashMap<String, GroupMetadata>, Error>

pub async fn get_metadata(&self, jid: &Jid) -> Result<GroupMetadata, Error>

pub async fn create_group( &self, options: GroupCreateOptions, ) -> Result<CreateGroupResult, Error>

pub async fn set_subject( &self, jid: &Jid, subject: GroupSubject, ) -> Result<(), Error>

pub async fn set_description( &self, jid: &Jid, description: Option<GroupDescription>, prev: Option<String>, ) -> Result<(), Error>

Sets or deletes a group’s description.

prev is the current description ID (from group metadata) used for conflict detection. Pass None if unknown.

pub async fn leave(&self, jid: &Jid) -> Result<(), Error>

pub async fn add_participants( &self, jid: &Jid, participants: &[Jid], ) -> Result<Vec<ParticipantChangeResponse>, Error>

pub async fn remove_participants( &self, jid: &Jid, participants: &[Jid], ) -> Result<Vec<ParticipantChangeResponse>, Error>

pub async fn promote_participants( &self, jid: &Jid, participants: &[Jid], ) -> Result<(), Error>

pub async fn demote_participants( &self, jid: &Jid, participants: &[Jid], ) -> Result<(), Error>

pub async fn get_invite_link( &self, jid: &Jid, reset: bool, ) -> Result<String, Error>

pub async fn set_locked(&self, jid: &Jid, locked: bool) -> Result<(), Error>

Lock the group so only admins can change group info.

pub async fn set_announce(&self, jid: &Jid, announce: bool) -> Result<(), Error>

Set announcement mode. When enabled, only admins can send messages.

pub async fn set_ephemeral( &self, jid: &Jid, expiration: u32, ) -> Result<(), Error>

Set ephemeral (disappearing) messages timer on the group.

Common values: 86400 (24h), 604800 (7d), 7776000 (90d). Pass 0 to disable.

pub async fn set_membership_approval( &self, jid: &Jid, mode: MembershipApprovalMode, ) -> Result<(), Error>

Set membership approval mode. When on, new members must be approved by an admin.

pub async fn join_with_invite_code( &self, code: &str, ) -> Result<JoinGroupResult, Error>

Join a group using an invite code.

pub async fn join_with_invite_v4( &self, group_jid: &Jid, code: &str, expiration: i64, admin_jid: &Jid, ) -> Result<JoinGroupResult, Error>

Accept a V4 invite (received as a GroupInviteMessage, not a link).

pub async fn get_invite_info(&self, code: &str) -> Result<GroupMetadata, Error>

Get group metadata from an invite code without joining.

pub async fn get_membership_requests( &self, jid: &Jid, ) -> Result<Vec<MembershipRequest>, Error>

Get pending membership approval requests.

pub async fn approve_membership_requests( &self, jid: &Jid, participants: &[Jid], ) -> Result<Vec<ParticipantChangeResponse>, Error>

Approve pending membership requests.

pub async fn reject_membership_requests( &self, jid: &Jid, participants: &[Jid], ) -> Result<Vec<ParticipantChangeResponse>, Error>

Reject pending membership requests.

pub async fn set_member_add_mode( &self, jid: &Jid, mode: MemberAddMode, ) -> Result<(), Error>

Set who can add members to the group.