C_Club.GetInvitationCandidates

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Blizzard Docs  Townlong Yak  Offline /api  GitHub Search
Info
Added in 8.0.1 / 1.13.2

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

candidates = C_Club.GetInvitationCandidates([filter, maxResults, cursorPosition, allowFullMatch], clubId)

Arguments

filter

string?

maxResults

number?

cursorPosition

number?

allowFullMatch

boolean?

clubId

string

Returns

candidates

ClubInvitationCandidateInfo[]

Field	Type	Description
memberId	number
name	string
priority	number
status	Enum.ClubInvitationCandidateStatus

Enum.ClubInvitationCandidateStatus

Value	Field	Description
0	Available
1	InvitePending
2	AlreadyMember

Patch changes

Patch 8.1.0 (2018-12-11): Added allowFullMatch argument.
Patch 8.0.1 (2018-07-17): Added.