 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards.
|
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.
