GameMaker Studio · GML · Groups & clans

gmda_cancelGroupInvitation

Withdraws a pending invitation the group sent (leader/officer only).

Asynchronous (result via event)

Signature

gmda_cancelGroupInvitation(invitation_id) -> real

What it does

POSTs /groups/invitations/cancel, then queues group_invitation_cancelled { success, response }. This is the group side withdrawing an invite it sent. On failure e.error carries the raw server message, e.g. "Invitation is not pending", "You cannot manage invitations", or "Invitation not found".

Parameters

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

How to call it

Call it, then read group_invitation_cancelled from gmda_pollEvent(). The caller needs invite permission; get ids from gmda_listGroupInvitations("outgoing").

Result event: group_invitation_cancelled { success, response }

Example

gmda_cancelGroupInvitation(invitation_id);

var e = gmda_pollEvent();
while (!is_undefined(e)) {
    if (e.event == "group_invitation_cancelled") {
        if (e.success) show_debug_message("Invitation cancelled");
        else show_debug_message("Failed: " + e.error);
    }
    e = gmda_pollEvent();
}

Use cases

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