~/forever/addon-api/function/C_Club.GetInvitationCandidates
C_Club.GetInvitationCandidates
documented function · Club
C_Club.GetInvitationCandidates(filter?, maxResults?, cursorPosition?, allowFullMatch?, clubId) : candidatesReturns a list of players that you can send a request to a Battle.net club. Returns an empty list for Character based clubs
──ARGUMENTS
- filter
- string, optional
- maxResults
- number, optional
- cursorPosition
- number, optional
- allowFullMatch
- bool, optional
- clubId
- ClubId
──RETURNS
- candidates
- table<ClubInvitationCandidateInfo>
──DETAILS
- Requires Clubs Initialized
- true
- Secret Arguments
- AllowedWhenUntainted
──VERSION HISTORY
Present since at least 1.60.1.70707, the first build we track.