com.playfab.PlayFabMatchmakerModels Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of combo-sdk Show documentation
Show all versions of combo-sdk Show documentation
PlayFab is the unified backend platform for games — everything you need to build and operate your game, all in one place, so you can focus on creating and delivering a great player experience.
package com.playfab;
import java.util.*;
import com.playfab.PlayFabUtil.*;
public class PlayFabMatchmakerModels {
/**
* This API allows the external match-making service to confirm that the user has a valid Session Ticket for the title, in
* order to securely enable match-making. The client passes the user's Session Ticket to the external match-making service,
* which then passes the Session Ticket in as the AuthorizationTicket in this call.
*/
public static class AuthUserRequest {
/** Session Ticket provided by the client. */
public String AuthorizationTicket;
}
public static class AuthUserResponse {
/** Boolean indicating if the user has been authorized to use the external match-making service. */
public Boolean Authorized;
/** PlayFab unique identifier of the account that has been authorized. */
public String PlayFabId;
}
/**
* A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags,
* Description that are the same across all instances of the item, a call to GetCatalogItems is required. The ItemID of can
* be matched to a catalog entry, which contains the additional information. Also note that Custom Data is only set when
* the User's specific instance has updated the CustomData via a call to UpdateUserInventoryItemCustomData. Other fields
* such as UnitPrice and UnitCurrency are only set when the item was granted via a purchase.
*/
public static class ItemInstance implements Comparable {
/** Game specific comment associated with this instance when it was added to the user inventory. */
public String Annotation;
/** Array of unique items that were awarded when this catalog item was purchased. */
public ArrayList BundleContents;
/**
* Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or
* container.
*/
public String BundleParent;
/** Catalog version for the inventory item, when this instance was created. */
public String CatalogVersion;
/**
* A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog
* item's custom data.
*/
public Map CustomData;
/** CatalogItem.DisplayName at the time this item was purchased. */
public String DisplayName;
/** Timestamp for when this instance will expire. */
public Date Expiration;
/** Class name for the inventory item, as defined in the catalog. */
public String ItemClass;
/** Unique identifier for the inventory item, as defined in the catalog. */
public String ItemId;
/** Unique item identifier for this specific instance of the item. */
public String ItemInstanceId;
/** Timestamp for when this instance was purchased. */
public Date PurchaseDate;
/** Total number of remaining uses, if this is a consumable item. */
public Integer RemainingUses;
/** Currency type for the cost of the catalog item. Not available when granting items. */
public String UnitCurrency;
/** Cost of the catalog item in the given currency. Not available when granting items. */
public Long UnitPrice;
/** The number of uses that were added or removed to this item in this call. */
public Integer UsesIncrementedBy;
public int compareTo(ItemInstance other) {
if (other == null || other.ItemInstanceId == null) return 1;
if (ItemInstanceId == null) return -1;
return ItemInstanceId.compareTo(other.ItemInstanceId);
}
}
public static class PlayerJoinedRequest {
/**
* Unique identifier of the Game Server Instance the user is joining. This must be a Game Server Instance started with the
* Matchmaker/StartGame API.
*/
public String LobbyId;
/** PlayFab unique identifier for the player joining. */
public String PlayFabId;
}
public static class PlayerJoinedResponse {
}
public static class PlayerLeftRequest {
/**
* Unique identifier of the Game Server Instance the user is leaving. This must be a Game Server Instance started with the
* Matchmaker/StartGame API.
*/
public String LobbyId;
/** PlayFab unique identifier for the player leaving. */
public String PlayFabId;
}
public static class PlayerLeftResponse {
}
public static enum Region {
USCentral,
USEast,
EUWest,
Singapore,
Japan,
Brazil,
Australia
}
public static class StartGameRequest {
/** Unique identifier of the previously uploaded build executable which is to be started. */
public String Build;
/** Custom command line argument when starting game server process. */
public String CustomCommandLineData;
/**
* HTTP endpoint URL for receiving game status events, if using an external matchmaker. When the game ends, PlayFab will
* make a POST request to this URL with the X-SecretKey header set to the value of the game's secret and an
* application/json body of { "EventName": "game_ended", "GameID": "<gameid>" }.
*/
public String ExternalMatchmakerEventEndpoint;
/** Game mode for this Game Server Instance. */
public String GameMode;
/** Region with which to associate the server, for filtering. */
public Region Region;
}
public static class StartGameResponse {
/** Unique identifier for the game/lobby in the new Game Server Instance. */
public String GameID;
/** IPV4 address of the server */
public String ServerIPV4Address;
/** IPV6 address of the new Game Server Instance. */
public String ServerIPV6Address;
/** Port number for communication with the Game Server Instance. */
public Long ServerPort;
/** Public DNS name (if any) of the server */
public String ServerPublicDNSName;
}
public static class UserInfoRequest {
/**
* Minimum catalog version for which data is requested (filters the results to only contain inventory items which have a
* catalog version of this or higher).
*/
public Integer MinCatalogVersion;
/** PlayFab unique identifier of the user whose information is being requested. */
public String PlayFabId;
}
public static class UserInfoResponse {
/** Array of inventory items in the user's current inventory. */
@Unordered("ItemInstanceId")
public ArrayList Inventory;
/** Boolean indicating whether the user is a developer. */
public Boolean IsDeveloper;
/** PlayFab unique identifier of the user whose information was requested. */
public String PlayFabId;
/** Steam unique identifier, if the user has an associated Steam account. */
public String SteamId;
/** Title specific display name, if set. */
public String TitleDisplayName;
/** PlayFab unique user name. */
public String Username;
/** Array of virtual currency balance(s) belonging to the user. */
public Map VirtualCurrency;
/** Array of remaining times and timestamps for virtual currencies. */
public Map VirtualCurrencyRechargeTimes;
}
public static class VirtualCurrencyRechargeTime {
/**
* Maximum value to which the regenerating currency will automatically increment. Note that it can exceed this value
* through use of the AddUserVirtualCurrency API call. However, it will not regenerate automatically until it has fallen
* below this value.
*/
public Integer RechargeMax;
/** Server timestamp in UTC indicating the next time the virtual currency will be incremented. */
public Date RechargeTime;
/** Time remaining (in seconds) before the next recharge increment of the virtual currency. */
public Integer SecondsToRecharge;
}
}