GameMaker Studio · GML · Groups & clans

gmda_cancelGroupRequest

Withdraws the caller's own pending join request.

Asynchronous (result via event)

Signature

gmda_cancelGroupRequest(request_id) -> real

What it does

POSTs /groups/requests/cancel, then queues group_request_cancelled { success, response }. This is the requester retracting their own application. On failure e.error carries the raw server message, e.g. "Request is not pending" or "Invalid request_id".

Parameters

Name	Type	Default	Description
request_id	string	required	Id of the caller's own pending request to withdraw.

How to call it

Call it, then read group_request_cancelled from gmda_pollEvent(). Only the requester may cancel; get ids from gmda_listGroupRequests("outgoing").

Result event: group_request_cancelled { success, response }

Example

gmda_cancelGroupRequest(request_id);

var e = gmda_pollEvent();
while (!is_undefined(e)) {
    if (e.event == "group_request_cancelled") {
        if (e.success) show_debug_message("Request withdrawn");
        else show_debug_message("Failed: " + e.error);
    }
    e = gmda_pollEvent();
}

Use cases

Let a player retract an application they no longer want.
Cancel a pending request before joining a different group.