com.playfab.PlayFabCloudScriptModels 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 PlayFabCloudScriptModels {
public static class AdCampaignAttributionModel {
/** UTC time stamp of attribution */
public Date AttributedAt;
/** Attribution campaign identifier */
public String CampaignId;
/** Attribution network name */
public String Platform;
}
public static enum CloudScriptRevisionOption {
Live,
Latest,
Specific
}
public static class ContactEmailInfoModel {
/** The email address */
public String EmailAddress;
/** The name of the email info data */
public String Name;
/** The verification status of the email */
public EmailVerificationStatus VerificationStatus;
}
public static enum ContinentCode {
AF,
AN,
AS,
EU,
NA,
OC,
SA
}
public static enum CountryCode {
AF,
AX,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BQ,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
KH,
CM,
CA,
CV,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CU,
CW,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IM,
IL,
IT,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
ME,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RW,
BL,
SH,
KN,
LC,
MF,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
RS,
SC,
SL,
SG,
SX,
SK,
SI,
SB,
SO,
ZA,
GS,
SS,
ES,
LK,
SD,
SR,
SJ,
SZ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW
}
public static enum EmailVerificationStatus {
Unverified,
Pending,
Confirmed
}
public static class EmptyResult {
}
/** Combined entity type and ID structure which uniquely identifies a single entity. */
public static class EntityKey {
/** Unique ID of the entity. */
public String Id;
/** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
public String Type;
}
public static class ExecuteCloudScriptResult {
/** Number of PlayFab API requests issued by the CloudScript function */
public Integer APIRequestsIssued;
/** Information about the error, if any, that occurred during execution */
public ScriptExecutionError Error;
public Double ExecutionTimeSeconds;
/** The name of the function that executed */
public String FunctionName;
/** The object returned from the CloudScript function, if any */
public Object FunctionResult;
/**
* Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. This only occurs if
* the total event size is larger than 350KB.
*/
public Boolean FunctionResultTooLarge;
/** Number of external HTTP requests issued by the CloudScript function */
public Integer HttpRequestsIssued;
/**
* Entries logged during the function execution. These include both entries logged in the function code using log.info()
* and log.error() and error entries for API and HTTP request failures.
*/
public ArrayList Logs;
/**
* Flag indicating if the logs were too large and were subsequently dropped from this event. This only occurs if the total
* event size is larger than 350KB after the FunctionResult was removed.
*/
public Boolean LogsTooLarge;
public Long MemoryConsumedBytes;
/**
* Processor time consumed while executing the function. This does not include time spent waiting on API calls or HTTP
* requests.
*/
public Double ProcessorTimeSeconds;
/** The revision of the CloudScript that executed */
public Integer Revision;
}
/** Executes CloudScript with the entity profile that is defined in the request. */
public static class ExecuteEntityCloudScriptRequest {
/** The entity to perform this action on. */
public EntityKey Entity;
/** The name of the CloudScript function to execute */
public String FunctionName;
/** Object that is passed in to the function as the first argument */
public Object FunctionParameter;
/**
* Generate a 'entity_executed_cloudscript' PlayStream event containing the results of the function execution and other
* contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
*/
public Boolean GeneratePlayStreamEvent;
/**
* Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live'
* executes the current live, published revision, and 'Specific' executes the specified revision. The default value is
* 'Specific', if the SpecificRevision parameter is specified, otherwise it is 'Live'.
*/
public CloudScriptRevisionOption RevisionSelection;
/** The specific revision to execute, when RevisionSelection is set to 'Specific' */
public Integer SpecificRevision;
}
/** Executes an Azure Function with the profile of the entity that is defined in the request. */
public static class ExecuteFunctionRequest {
/** The entity to perform this action on. */
public EntityKey Entity;
/** The name of the CloudScript function to execute */
public String FunctionName;
/** Object that is passed in to the function as the FunctionArgument field of the FunctionExecutionContext data structure */
public Object FunctionParameter;
/**
* Generate a 'entity_executed_cloudscript_function' PlayStream event containing the results of the function execution and
* other contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
*/
public Boolean GeneratePlayStreamEvent;
}
public static class ExecuteFunctionResult {
/** Error from the CloudScript Azure Function. */
public FunctionExecutionError Error;
/** The amount of time the function took to execute */
public Integer ExecutionTimeMilliseconds;
/** The name of the function that executed */
public String FunctionName;
/** The object returned from the function, if any */
public Object FunctionResult;
/** Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. */
public Boolean FunctionResultTooLarge;
}
public static class FunctionExecutionError {
/**
* Error code, such as CloudScriptAzureFunctionsExecutionTimeLimitExceeded, CloudScriptAzureFunctionsArgumentSizeExceeded,
* CloudScriptAzureFunctionsReturnSizeExceeded or CloudScriptAzureFunctionsHTTPRequestError
*/
public String Error;
/** Details about the error */
public String Message;
/** Point during the execution of the function at which the error occurred, if any */
public String StackTrace;
}
public static class FunctionModel {
/** The address of the function. */
public String FunctionAddress;
/** The name the function was registered under. */
public String FunctionName;
/** The trigger type for the function. */
public String TriggerType;
}
public static class HttpFunctionModel {
/** The name the function was registered under. */
public String FunctionName;
/** The URL of the function. */
public String FunctionUrl;
}
public static class LinkedPlatformAccountModel {
/** Linked account email of the user on the platform, if available */
public String Email;
/** Authentication platform */
public LoginIdentityProvider Platform;
/** Unique account identifier of the user on the platform */
public String PlatformUserId;
/** Linked account username of the user on the platform, if available */
public String Username;
}
/**
* A title can have many functions, ListHttpFunctions will return a list of all the currently registered HTTP triggered
* functions for a given title.
*/
public static class ListFunctionsRequest {
}
public static class ListFunctionsResult {
/** The list of functions that are currently registered for the title. */
public ArrayList Functions;
}
public static class ListHttpFunctionsResult {
/** The list of HTTP triggered functions that are currently registered for the title. */
public ArrayList Functions;
}
public static class ListQueuedFunctionsResult {
/** The list of Queue triggered functions that are currently registered for the title. */
public ArrayList Functions;
}
public static class LocationModel {
/** City name. */
public String City;
/** The two-character continent code for this location */
public ContinentCode ContinentCode;
/** The two-character ISO 3166-1 country code for the country associated with the location */
public CountryCode CountryCode;
/** Latitude coordinate of the geographic location. */
public Double Latitude;
/** Longitude coordinate of the geographic location. */
public Double Longitude;
}
public static enum LoginIdentityProvider {
Unknown,
PlayFab,
Custom,
GameCenter,
GooglePlay,
Steam,
XBoxLive,
PSN,
Kongregate,
Facebook,
IOSDevice,
AndroidDevice,
Twitch,
WindowsHello,
GameServer,
CustomServer,
NintendoSwitch,
FacebookInstantGames,
OpenIdConnect,
Apple,
NintendoSwitchAccount
}
public static class LogStatement {
/** Optional object accompanying the message as contextual information */
public Object Data;
/** 'Debug', 'Info', or 'Error' */
public String Level;
public String Message;
}
public static class MembershipModel {
/** Whether this membership is active. That is, whether the MembershipExpiration time has been reached. */
public Boolean IsActive;
/** The time this membership expires */
public Date MembershipExpiration;
/** The id of the membership */
public String MembershipId;
/**
* Membership expirations can be explicitly overridden (via game manager or the admin api). If this membership has been
* overridden, this will be the new expiration time.
*/
public Date OverrideExpiration;
/** The list of subscriptions that this player has for this membership */
public ArrayList Subscriptions;
}
/**
* Identifier by either name or ID. Note that a name may change due to renaming, or reused after being deleted. ID is
* immutable and unique.
*/
public static class NameIdentifier {
/** Id Identifier, if present */
public String Id;
/** Name Identifier, if present */
public String Name;
}
public static class PlayerProfileModel {
/** List of advertising campaigns the player has been attributed to */
public ArrayList AdCampaignAttributions;
/** URL of the player's avatar image */
public String AvatarUrl;
/** If the player is currently banned, the UTC Date when the ban expires */
public Date BannedUntil;
/** List of all contact email info associated with the player account */
public ArrayList ContactEmailAddresses;
/** Player record created */
public Date Created;
/** Player display name */
public String DisplayName;
/** List of experiment variants for the player. */
public ArrayList ExperimentVariants;
/** UTC time when the player most recently logged in to the title */
public Date LastLogin;
/** List of all authentication systems linked to this player account */
public ArrayList LinkedAccounts;
/** List of geographic locations from which the player has logged in to the title */
public ArrayList Locations;
/** List of memberships for the player, along with whether are expired. */
public ArrayList Memberships;
/** Player account origination */
public LoginIdentityProvider Origination;
/** PlayFab player account unique identifier */
public String PlayerId;
/** Publisher this player belongs to */
public String PublisherId;
/** List of configured end points registered for sending the player push notifications */
public ArrayList PushNotificationRegistrations;
/** List of leaderboard statistic values for the player */
public ArrayList Statistics;
/** List of player's tags for segmentation */
public ArrayList Tags;
/** Title ID this player profile applies to */
public String TitleId;
/**
* Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a
* whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.
*/
public Long TotalValueToDateInUSD;
/** List of the player's lifetime purchase totals, summed by real-money currency */
public ArrayList ValuesToDate;
}
public static class PlayStreamEventEnvelopeModel {
/** The ID of the entity the event is about. */
public String EntityId;
/** The type of the entity the event is about. */
public String EntityType;
/** Data specific to this event. */
public String EventData;
/** The name of the event. */
public String EventName;
/** The namespace of the event. */
public String EventNamespace;
/** Settings for the event. */
public String EventSettings;
}
public static class PostFunctionResultForEntityTriggeredActionRequest {
/** The entity to perform this action on. */
public EntityKey Entity;
/** The result of the function execution. */
public ExecuteFunctionResult FunctionResult;
}
public static class PostFunctionResultForFunctionExecutionRequest {
/** The entity to perform this action on. */
public EntityKey Entity;
/** The result of the function execution. */
public ExecuteFunctionResult FunctionResult;
}
public static class PostFunctionResultForPlayerTriggeredActionRequest {
/** The entity to perform this action on. */
public EntityKey Entity;
/** The result of the function execution. */
public ExecuteFunctionResult FunctionResult;
/** The player profile the function was invoked with. */
public PlayerProfileModel PlayerProfile;
/** The triggering PlayStream event, if any, that caused the function to be invoked. */
public PlayStreamEventEnvelopeModel PlayStreamEventEnvelope;
}
public static class PostFunctionResultForScheduledTaskRequest {
/** The entity to perform this action on. */
public EntityKey Entity;
/** The result of the function execution */
public ExecuteFunctionResult FunctionResult;
/** The id of the scheduled task that invoked the function. */
public NameIdentifier ScheduledTaskId;
}
public static enum PushNotificationPlatform {
ApplePushNotificationService,
GoogleCloudMessaging
}
public static class PushNotificationRegistrationModel {
/** Notification configured endpoint */
public String NotificationEndpointARN;
/** Push notification platform */
public PushNotificationPlatform Platform;
}
public static class QueuedFunctionModel {
/** The connection string for the Azure Storage Account that hosts the queue. */
public String ConnectionString;
/** The name the function was registered under. */
public String FunctionName;
/** The name of the queue that triggers the Azure Function. */
public String QueueName;
}
public static class RegisterHttpFunctionRequest {
/** The name of the function to register */
public String FunctionName;
/** Full URL for Azure Function that implements the function. */
public String FunctionUrl;
}
/**
* A title can have many functions, RegisterQueuedFunction associates a function name with a queue name and connection
* string.
*/
public static class RegisterQueuedFunctionRequest {
/** A connection string for the storage account that hosts the queue for the Azure Function. */
public String ConnectionString;
/** The name of the function to register */
public String FunctionName;
/** The name of the queue for the Azure Function. */
public String QueueName;
}
public static class ScriptExecutionError {
/**
* Error code, such as CloudScriptNotFound, JavascriptException, CloudScriptFunctionArgumentSizeExceeded,
* CloudScriptAPIRequestCountExceeded, CloudScriptAPIRequestError, or CloudScriptHTTPRequestError
*/
public String Error;
/** Details about the error */
public String Message;
/** Point during the execution of the script at which the error occurred, if any */
public String StackTrace;
}
public static class StatisticModel {
/** Statistic name */
public String Name;
/** Statistic value */
public Integer Value;
/** Statistic version (0 if not a versioned statistic) */
public Integer Version;
}
public static class SubscriptionModel {
/** When this subscription expires. */
public Date Expiration;
/** The time the subscription was orignially purchased */
public Date InitialSubscriptionTime;
/** Whether this subscription is currently active. That is, if Expiration > now. */
public Boolean IsActive;
/** The status of this subscription, according to the subscription provider. */
public SubscriptionProviderStatus Status;
/** The id for this subscription */
public String SubscriptionId;
/** The item id for this subscription from the primary catalog */
public String SubscriptionItemId;
/** The provider for this subscription. Apple or Google Play are supported today. */
public String SubscriptionProvider;
}
public static enum SubscriptionProviderStatus {
NoError,
Cancelled,
UnknownError,
BillingError,
ProductUnavailable,
CustomerDidNotAcceptPriceChange,
FreeTrial,
PaymentPending
}
public static class TagModel {
/** Full value of the tag, including namespace */
public String TagValue;
}
public static enum TriggerType {
HTTP,
Queue
}
public static class UnregisterFunctionRequest {
/** The name of the function to unregister */
public String FunctionName;
}
public static class ValueToDateModel {
/** ISO 4217 code of the currency used in the purchases */
public String Currency;
/**
* Total value of the purchases in a whole number of 1/100 monetary units. For example, 999 indicates nine dollars and
* ninety-nine cents when Currency is 'USD')
*/
public Long TotalValue;
/**
* Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine
* dollars and ninety-nine cents when Currency is 'USD'.
*/
public String TotalValueAsDecimal;
}
}