v0.13.7

C_Club.GetInvitationCandidates

functionguessedavailable in: camelot

Returns a list of players that you can send a request to a Battle.net club. Returns an empty list for Character based clubs

signaturewowlua
function C_Club.GetInvitationCandidates(    filter: string?,    maxResults: number?,    cursorPosition: number?,    allowFullMatch: boolean?,    clubId: ClubId): ClubInvitationCandidateInfo[]

Parameters

nametype
filterstring?
maxResultsnumber?
cursorPositionnumber?
allowFullMatchboolean?
clubIdClubId

Returns

candidates · ClubInvitationCandidateInfo[]

ClubInvitationCandidateInfo
fieldtype
memberIdClubMemberOpaqueId
namestring
prioritynumber
statusClubInvitationCandidateStatus

In wowlua's emulated client

guessedThe answer is worked out from Blizzard's documentation, its UI code and the function's name, and not checked against the client. what the statuses mean

Restrictions

  • Requires clubs initialized.

sources

Signature and flags: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (Club system, camelot 1.60.1). Description: warcraft.wiki.gg's API pages ↗, by its contributors, CC BY-SA 4.0 ↗.