searchGlobalDisplayNames() and Documentation

Author: BuildTools

src/main/java/material/DestinyAPI.java

@@ -170,7 +170,12 @@ public static UserCredential getUserCredential(UserCredentialType type, BungieUs
 	}
 
 	/**
-	 * Gets the users with this name (There can be multiple users with the same name)
+	 * Search for a user
+	 *
+	 * You need to enter both their username and discriminator
+	 *
+	 * e.g. "dec4234#9904"
+	 * If you only know their name, use searchBungieGlobalDisplayNames()
 	 */
 	public static List<BungieUser> getUsersWithName(String name) {
 		HttpUtils hu = new HttpUtils();
@@ -208,6 +213,31 @@ public static List<BungieUser> getValidUsers(String name) {
 		return list;
 	}
 
+	/**
+	 * You use this method to search for a user purely by their username
+	 *
+	 * For getUsersWithName() you would need to search "dec4234#9904"
+	 * while for this you can search with "dec4234"
+	 */
+	public static List<BungieUser> searchGlobalDisplayNames(String prefix) {
+		List<BungieUser> bungieUsers = new ArrayList<>();
+
+		JsonArray jsonArray = new HttpUtils().urlRequestGET("https://www.bungie.net/Platform/User/Search/Prefix/" + prefix + "/0/").getAsJsonObject("Response").getAsJsonArray("searchResults");
+
+		for(JsonElement jsonElement : jsonArray) {
+			JsonObject jsonObject = jsonElement.getAsJsonObject();
+			JsonObject destinyMembership = jsonObject.getAsJsonArray("destinyMemberships").get(0).getAsJsonObject();
+
+			BungieUser bungieUser = new BungieUser(destinyMembership.get("membershipId").getAsString(), destinyMembership.get("displayName").getAsString(),
+					destinyMembership.get("bungieGlobalDisplayName").getAsString(), destinyMembership.get("crossSaveOverride").getAsInt(), destinyMembership.get("membershipType").getAsInt(),
+					destinyMembership.get("isPublic").getAsBoolean());
+
+			bungieUsers.add(bungieUser);
+		}
+
+		return bungieUsers;
+	}
+
 	public static Clan getClan(long id) {
 		return new Clan(id);
 	}

src/main/java/material/user/BungieUser.java

@@ -33,7 +33,7 @@
  */
 public class BungieUser extends ContentFramework {
 
-	private String bungieMembershipID, displayName, supplementalDisplayName, discriminator;
+	private String bungieMembershipID, displayName, globalDisplayName, supplementalDisplayName, discriminator;
 	private Date lastPlayed;
 	private JsonObject je; // The JsonObject of the profile used to get most information
 	private HttpUtils hu = new HttpUtils();
@@ -92,6 +92,18 @@ public BungieUser(String bungieMembershipID, String displayName, int crossSaveOv
 		this.isPublic = isPublic;
 	}
 
+	public BungieUser(String bungieMembershipID, String displayName, String globalDisplayName, int crossSaveOverride, int membershipType, boolean isPublic) {
+		super("https://www.bungie.net/Platform/Destiny2/-1/Profile/" + bungieMembershipID + "/LinkedProfiles/?components=200", source -> {
+			return source.getAsJsonObject("Response");
+		});
+		this.bungieMembershipID = bungieMembershipID;
+		this.displayName = displayName;
+		this.globalDisplayName = globalDisplayName;
+		this.crossSaveOverride = crossSaveOverride;
+		this.membershipType = membershipType;
+		this.isPublic = isPublic;
+	}
+
 	/**
 	 * Gets the bungie membership ID of the user
 	 */
@@ -121,6 +133,21 @@ public String getDisplayName() {
 		return displayName;
 	}
 
+	public String getGlobalDisplayName() {
+		getJE();
+
+		if(globalDisplayName == null) {
+
+		}
+
+		return globalDisplayName;
+	}
+
+	/**
+	 * Returns the combined displayname and user discriminator as used in friend requests and user searches
+	 *
+	 * E.g. dec4234#9904
+	 */
 	public String getSupplementalDisplayName() {
 		if(supplementalDisplayName == null) {
 			supplementalDisplayName = getJO().getAsJsonObject("bnetMembership").get("supplementalDisplayName").getAsString();
@@ -129,6 +156,11 @@ public String getSupplementalDisplayName() {
 		return supplementalDisplayName;
 	}
 
+	/**
+	 * Get the discriminator of a user's name
+	 *
+	 * E.g. "9904" of dec4234#9904
+	 */
 	public String getDiscriminator() {
 		if(discriminator == null) {
 			discriminator = getSupplementalDisplayName().split("#")[1];