Skip to main content
Version: 5.18.17

GetApplicantsV3

public BackendReturnObject GetApplicantsV3();
public BackendReturnObject GetApplicantsV3(int limit);
public BackendReturnObject GetApplicantsV3(int limit, int offset);

Parameters​

ValueTypeDescriptiondefault
limitint(Optional) Number of lists of users who request to join100
offsetint(Optional) Starting point to look up the list of users who request to join (offset)0

Description​

Looks up lists of users who request to join a guild.
The applicant list is sorted according to a first-come, first-served rule.

  • If 'limit' is 0 or below, it is called as 100.

If users 1, 2, and 3 apply in order, the list will show User 1 in the 0th place, User 2 in the 1st place, and User 3 in the 2nd place.

Example​

Synchronous​

Backend.Guild.GetApplicantsV3();
Backend.Guild.GetApplicantsV3(5);
Backend.Guild.GetApplicantsV3(5, 5);

Asynchronous​

Backend.Guild.GetApplicantsV3((callback) => {
// Post-process
});
Backend.Guild.GetApplicantsV3(5, (callback) => {
// Post-process
});
Backend.Guild.GetApplicantsV3(5, 5, (callback) => {
// Post-process
});

SendQueue​

SendQueue.Enqueue(Backend.Guild.GetApplicantsV3, (callback) => {
// Post-process
});
SendQueue.Enqueue(Backend.Guild.GetApplicantsV3, 5, (callback) => {
// Post-process
});
SendQueue.Enqueue(Backend.Guild.GetApplicantsV3, 5, 5, (callback) => {
// Post-process
});

ReturnCase​

Success cases​

When the lookup is successful
statusCode : 200
message : Success
returnValue : refer to GetReturnValuetoJSON

When the user is not a guild master or manager
statusCode : 403
errorCode : ForbiddenException
message : Forbidden selectApplicant, Forbidden selectApplicant

When a user who has not joined a guild calls the method
statusCode : 412
errorCode : PreconditionFailed
message : notGuildMember prerequisites are not met.

GetReturnValuetoJSON​

{
rows: [
{
inDate: { S: "2018-07-31T01:34:41.461Z" }, // indate of the user who requested to join
nickname: { S: "customid10" }, // Nickname of the user who requested to join
},
{
inDate: { S: "2018-07-31T01:49:47.260Z" },
nickname: { S: "customid4" },
},
];
}

Sample Code​

public class ApplicantsItem
{
public string inDate;
public string nickname;
public override string ToString()
{
return $"nickname : {nickname}\ninDate : {inDate}\n";
}
}
public void GetApplicantsV3()
{
var bro = Backend.Guild.GetApplicantsV3();

if(!bro.IsSuccess())
return;

List<ApplicantsItem> applicantsList = new List<ApplicantsItem>();

LitJson.JsonData applicantsListJson = bro.FlattenRows();

for(int i = 0; i < applicantsListJson.Count; i++)
{
ApplicantsItem applicant = new ApplicantsItem();

if(applicantsListJson[i].ContainsKey("nickname"))
{
applicant.nickname = applicantsListJson[i]["nickname"].ToString();
}
applicant.inDate = applicantsListJson[i]["inDate"].ToString();

applicantsList.Add(applicant);
Debug.Log(applicant.ToString());
}
}