Godot 4 · GDScript · Groups & clans

cancel_group_invitation

Withdraws a pending invitation the group sent (requires the can_invite permission).

Asynchronous (result via signal)

Signature

cancel_group_invitation(invitation_id: String) -> void

What it does

POSTs /groups/invitations/cancel. This is the group side withdrawing an invite it sent. error_code may be not_pending / insufficient_rank / not_found.

Parameters

Name	Type	Default	Description
invitation_id	String	required	Id of the outgoing invitation to cancel.

How to call it

Connect group_invitation_cancelled first, then call cancel_group_invitation(). The caller needs the can_invite permission; get ids from list_group_invitations("outgoing").

Result signal: group_invitation_cancelled(success: bool, error_code: String)

Example

Gamdato.group_invitation_cancelled.connect(_on_g_cancel)
Gamdato.cancel_group_invitation(invitation_id)

func _on_g_cancel(ok: bool, error_code: String) -> void:
    if ok: print("Invitation cancelled")
    else: print("Failed: %s" % error_code)

Use cases

Let officers retract an invite sent to the wrong player.
Clean up stale outgoing invitations.