Library referenceClasses
PublicClansApi
GET /clans/*: clan profiles, loot config, motd and the recruitment board
Constructors
Constructor
new PublicClansApi(gapi): PublicClansApi;Parameters
| Parameter | Type |
|---|---|
gapi | KrunkerClient |
Returns
PublicClansApi
Methods
byName()
byName(clanName): Promise<ClanPublicProfile>;GET /clans/by-name/:name, case-insensitive, the roster has no player ids
Parameters
| Parameter | Type |
|---|---|
clanName | string |
Returns
Promise<ClanPublicProfile>
lootConfig()
lootConfig(clanId): Promise<ClanLootConfig>;GET /clans/:id/loot-config, the turf payout rule
Parameters
| Parameter | Type |
|---|---|
clanId | number |
Returns
Promise<ClanLootConfig>
motd()
motd(clanId): Promise<ClanMotd>;GET /clans/:id/motd
Parameters
| Parameter | Type |
|---|---|
clanId | number |
Returns
Promise<ClanMotd>
profile()
profile(clanId): Promise<ClanPublicProfile>;GET /clans/:id/profile, same reply by id
Parameters
| Parameter | Type |
|---|---|
clanId | number |
Returns
Promise<ClanPublicProfile>
recruitment()
recruitment(clanId): Promise<RecruitmentPost>;GET /clans/:id/recruitment, the clan's own board post
Parameters
| Parameter | Type |
|---|---|
clanId | number |
Returns
Promise<RecruitmentPost>
recruitmentBoard()
recruitmentBoard(query?): Promise<RecruitmentBoard>;GET /clans/recruitment, the recruitment board
Parameters
| Parameter | Type |
|---|---|
query? | RecruitmentQuery |
Returns
Promise<RecruitmentBoard>