Godot 4 · GDScript · Groups & clans

list_group_invitations

Lists group invitations, incoming or outgoing.

Asynchronous (result via signal)

Signature

list_group_invitations(direction: String = "incoming", status: String = "pending", limit: int = 50) -> void

What it does

POSTs /groups/invitations/list. invitations = Array of { id, direction, group_id, group_name, counterpart, status, message, created_at, ... }. Returns [] when there is no active session.

Parameters

Name	Type	Default	Description
direction	String	"incoming"	"incoming" (invites to you) or "outgoing" (invites your group sent).
status	String	"pending"	Filter: pending / accepted / declined / cancelled / expired.
limit	int	50	Max results, clamped to 1-100.

How to call it

Connect group_invitations_listed first, then call list_group_invitations(). Use the returned id with respond_group_invitation() (incoming) or cancel_group_invitation() (outgoing).

Result signal: group_invitations_listed(invitations: Array)

Example

Gamdato.group_invitations_listed.connect(_on_g_invites)
Gamdato.list_group_invitations("incoming")   # -> group_invitations_listed

func _on_g_invites(invitations: Array) -> void:
    for inv in invitations:
        print("%s invited you" % inv.group_name)

Use cases

Show a player their pending clan invites.
Let leaders review the invitations their group has sent out.

Справочник функций