UNPKG

@xmobitea/gn-server

Version:

GearN Server by XmobiTea (Pro)

618 lines (617 loc) 26.5 kB
import { IBuilder } from "./../../GN-library/xbuilder/lib/IBuilder"; export declare enum SecretRole { Admin = 1, Server = 2, Client = 3 } export interface PermissionRules { selfEnable: boolean; otherSelfEnable: boolean; adminSelfEnable: boolean; serverSelfEnable: boolean; } export interface GroupPermissionRules { selfEnable: boolean; otherSelfEnable: boolean; adminSelfEnable: boolean; serverSelfEnable: boolean; } export interface InventoryPermissionRules { selfEnable: boolean; otherSelfEnable: boolean; adminSelfEnable: boolean; serverSelfEnable: boolean; } export interface AuthenticatePermissionRules { selfEnable: boolean; otherSelfEnable: boolean; adminSelfEnable: boolean; serverSelfEnable: boolean; } export interface MasterPlayerPermissionRules { selfEnable: boolean; otherSelfEnable: boolean; adminSelfEnable: boolean; serverSelfEnable: boolean; } export interface GamePlayerPermissionRules { selfEnable: boolean; otherSelfEnable: boolean; adminSelfEnable: boolean; serverSelfEnable: boolean; } export interface CharacterPlayerPermissionRules { selfEnable: boolean; otherSelfEnable: boolean; adminSelfEnable: boolean; serverSelfEnable: boolean; } export interface ContentPermissionRules { selfEnable: boolean; otherSelfEnable: boolean; adminSelfEnable: boolean; serverSelfEnable: boolean; } export interface DashboardPermissionRules { selfEnable: boolean; otherSelfEnable: boolean; adminSelfEnable: boolean; serverSelfEnable: boolean; } export interface MultiplayerPermissionRules { selfEnable: boolean; otherSelfEnable: boolean; adminSelfEnable: boolean; serverSelfEnable: boolean; } export interface CloudScriptPermissionRules { selfEnable: boolean; otherSelfEnable: boolean; adminSelfEnable: boolean; serverSelfEnable: boolean; } export interface StoreInventoryPermissionRules { selfEnable: boolean; otherSelfEnable: boolean; adminSelfEnable: boolean; serverSelfEnable: boolean; } export interface SecretPermissionItem { authenticate: { loginByAccount: AuthenticatePermissionRules; loginByAndroidDeviceId: AuthenticatePermissionRules; loginByApple: AuthenticatePermissionRules; loginByCustomDeviceId: AuthenticatePermissionRules; loginByCustomId: AuthenticatePermissionRules; loginByFacebook: AuthenticatePermissionRules; loginByGenericService: AuthenticatePermissionRules; loginByGoogle: AuthenticatePermissionRules; loginByGooglePlayGameService: AuthenticatePermissionRules; loginByGameCenter: AuthenticatePermissionRules; loginByiOSDeviceId: AuthenticatePermissionRules; loginByWindowsPhoneDeviceId: AuthenticatePermissionRules; registerAccount: AuthenticatePermissionRules; loginByEditorDeviceId: AuthenticatePermissionRules; loginByLinuxDeviceId: AuthenticatePermissionRules; loginByMacOSDeviceId: AuthenticatePermissionRules; loginByWindowsDeviceId: AuthenticatePermissionRules; refreshAuthToken: AuthenticatePermissionRules; }; masterPlayer: { linkAccount: MasterPlayerPermissionRules; linkAndroidDeviceId: MasterPlayerPermissionRules; linkApple: MasterPlayerPermissionRules; linkCustomDeviceId: MasterPlayerPermissionRules; linkCustomId: MasterPlayerPermissionRules; linkEditorDeviceId: MasterPlayerPermissionRules; linkFacebook: MasterPlayerPermissionRules; linkGenericService: MasterPlayerPermissionRules; linkGoogle: MasterPlayerPermissionRules; linkiOSDeviceId: MasterPlayerPermissionRules; linkLinuxDeviceId: MasterPlayerPermissionRules; linkMacOSDeviceId: MasterPlayerPermissionRules; linkWindowsDeviceId: MasterPlayerPermissionRules; linkWindowsPhoneDeviceId: MasterPlayerPermissionRules; linkGooglePlayGameService: MasterPlayerPermissionRules; linkGameCenter: MasterPlayerPermissionRules; unlinkAccount: MasterPlayerPermissionRules; unlinkAndroidDeviceId: MasterPlayerPermissionRules; unlinkApple: MasterPlayerPermissionRules; unlinkCustomDeviceId: MasterPlayerPermissionRules; unlinkCustomId: MasterPlayerPermissionRules; unlinkEditorDeviceId: MasterPlayerPermissionRules; unlinkFacebook: MasterPlayerPermissionRules; unlinkGenericService: MasterPlayerPermissionRules; unlinkGoogle: MasterPlayerPermissionRules; unlinkiOSDeviceId: MasterPlayerPermissionRules; unlinkLinuxDeviceId: MasterPlayerPermissionRules; unlinkMacOSDeviceId: MasterPlayerPermissionRules; unlinkWindowsDeviceId: MasterPlayerPermissionRules; unlinkWindowsPhoneDeviceId: MasterPlayerPermissionRules; unlinkGooglePlayGameService: MasterPlayerPermissionRules; unlinkGameCenter: MasterPlayerPermissionRules; addSegment: MasterPlayerPermissionRules; removeSegment: MasterPlayerPermissionRules; getSegment: MasterPlayerPermissionRules; setTag: MasterPlayerPermissionRules; removeTag: MasterPlayerPermissionRules; getTag: MasterPlayerPermissionRules; getDisplayName: MasterPlayerPermissionRules; setDisplayName: MasterPlayerPermissionRules; getTsCreate: MasterPlayerPermissionRules; getIpAddressCreate: MasterPlayerPermissionRules; updateTsLastLogin: MasterPlayerPermissionRules; getTsLastLogin: MasterPlayerPermissionRules; setPlayerBan: MasterPlayerPermissionRules; getPlayerBan: MasterPlayerPermissionRules; setCountryCode: MasterPlayerPermissionRules; getCountryCode: MasterPlayerPermissionRules; changeAccountPassword: MasterPlayerPermissionRules; resetAccountPassword: MasterPlayerPermissionRules; setAvatar: MasterPlayerPermissionRules; getAvatar: MasterPlayerPermissionRules; changePlayerCurrency: MasterPlayerPermissionRules; getPlayerCurrency: MasterPlayerPermissionRules; changePlayerStatistics: MasterPlayerPermissionRules; getPlayerStatistics: MasterPlayerPermissionRules; getStatisticsLeaderboard: MasterPlayerPermissionRules; getStatisticsLeaderboardAroundPlayer: MasterPlayerPermissionRules; getCustomData: MasterPlayerPermissionRules; setCustomData: MasterPlayerPermissionRules; setPlayerData: MasterPlayerPermissionRules; getPlayerData: MasterPlayerPermissionRules; getPlayerInformation: MasterPlayerPermissionRules; getPlayersWithApple: MasterPlayerPermissionRules; getPlayersWithFacebook: MasterPlayerPermissionRules; getPlayersWithGoogle: MasterPlayerPermissionRules; getPlayersWithGenericService: MasterPlayerPermissionRules; getPlayersWithSegment: MasterPlayerPermissionRules; getPlayersWithTag: MasterPlayerPermissionRules; getPlayersWithGooglePlayGameService: MasterPlayerPermissionRules; getPlayersWithGameCenter: MasterPlayerPermissionRules; getExternal: MasterPlayerPermissionRules; getPlayersWithDisplayName: MasterPlayerPermissionRules; setEmail: MasterPlayerPermissionRules; getEmail: MasterPlayerPermissionRules; getCurrencyLeaderboard: MasterPlayerPermissionRules; getCreateLeaderboard: MasterPlayerPermissionRules; getLastLoginLeaderboard: MasterPlayerPermissionRules; getStatisticsLog: MasterPlayerPermissionRules; getCurrencyLog: MasterPlayerPermissionRules; sendSocketOperationEvent: MasterPlayerPermissionRules; sendEmail: MasterPlayerPermissionRules; sendPushNotification: MasterPlayerPermissionRules; getPushNotification: MasterPlayerPermissionRules; addPushNotification: MasterPlayerPermissionRules; removePushNotification: MasterPlayerPermissionRules; }; gamePlayer: { addSegment: GamePlayerPermissionRules; removeSegment: GamePlayerPermissionRules; getSegment: GamePlayerPermissionRules; setTag: GamePlayerPermissionRules; removeTag: GamePlayerPermissionRules; getTag: GamePlayerPermissionRules; getDisplayName: GamePlayerPermissionRules; setDisplayName: GamePlayerPermissionRules; getTsCreate: GamePlayerPermissionRules; getIpAddressCreate: GamePlayerPermissionRules; getTsLastLogin: GamePlayerPermissionRules; setPlayerBan: GamePlayerPermissionRules; getPlayerBan: GamePlayerPermissionRules; setCountryCode: GamePlayerPermissionRules; getCountryCode: GamePlayerPermissionRules; setAvatar: GamePlayerPermissionRules; getAvatar: GamePlayerPermissionRules; changePlayerCurrency: GamePlayerPermissionRules; getPlayerCurrency: GamePlayerPermissionRules; changePlayerStatistics: GamePlayerPermissionRules; getPlayerStatistics: GamePlayerPermissionRules; getStatisticsLeaderboard: GamePlayerPermissionRules; getStatisticsLeaderboardAroundPlayer: GamePlayerPermissionRules; getCustomData: GamePlayerPermissionRules; setCustomData: GamePlayerPermissionRules; setPlayerData: GamePlayerPermissionRules; getPlayerData: GamePlayerPermissionRules; getPlayerInformation: GamePlayerPermissionRules; getPlayersWithSegment: GamePlayerPermissionRules; getPlayersWithTag: GamePlayerPermissionRules; getPlayerCharacter: GamePlayerPermissionRules; getPlayerInventory: GamePlayerPermissionRules; getPlayerGroup: GamePlayerPermissionRules; getPlayerFriend: GamePlayerPermissionRules; removePlayerItem: GamePlayerPermissionRules; getOnlineStatus: GamePlayerPermissionRules; createGroup: GamePlayerPermissionRules; createPlayerItem: GamePlayerPermissionRules; createPlayerCharacter: GamePlayerPermissionRules; addPlayerFriend: GamePlayerPermissionRules; removePlayerFriend: GamePlayerPermissionRules; removePlayerCharacter: GamePlayerPermissionRules; joinGroup: GamePlayerPermissionRules; leaveGroup: GamePlayerPermissionRules; getPlayersWithDisplayName: GamePlayerPermissionRules; getFriendStatisticsLeaderboardAroundPlayer: GamePlayerPermissionRules; getFriendStatisticsLeaderboard: GamePlayerPermissionRules; getCurrencyLeaderboard: GamePlayerPermissionRules; getCreateLeaderboard: GamePlayerPermissionRules; getLastLoginLeaderboard: MasterPlayerPermissionRules; getStatisticsLog: GamePlayerPermissionRules; getCurrencyLog: GamePlayerPermissionRules; }; characterPlayer: { addSegment: CharacterPlayerPermissionRules; removeSegment: CharacterPlayerPermissionRules; getSegment: CharacterPlayerPermissionRules; setTag: CharacterPlayerPermissionRules; removeTag: CharacterPlayerPermissionRules; getTag: CharacterPlayerPermissionRules; getDisplayName: CharacterPlayerPermissionRules; setDisplayName: CharacterPlayerPermissionRules; getTsCreate: CharacterPlayerPermissionRules; getIpAddressCreate: CharacterPlayerPermissionRules; getTsLastLogin: CharacterPlayerPermissionRules; setPlayerBan: CharacterPlayerPermissionRules; getPlayerBan: CharacterPlayerPermissionRules; setCountryCode: CharacterPlayerPermissionRules; getCountryCode: CharacterPlayerPermissionRules; setAvatar: CharacterPlayerPermissionRules; getAvatar: CharacterPlayerPermissionRules; changePlayerCurrency: CharacterPlayerPermissionRules; getPlayerCurrency: CharacterPlayerPermissionRules; changePlayerStatistics: CharacterPlayerPermissionRules; getPlayerStatistics: CharacterPlayerPermissionRules; getStatisticsLeaderboard: CharacterPlayerPermissionRules; getStatisticsLeaderboardAroundPlayer: CharacterPlayerPermissionRules; getCustomData: CharacterPlayerPermissionRules; setCustomData: CharacterPlayerPermissionRules; setPlayerData: CharacterPlayerPermissionRules; getPlayerData: CharacterPlayerPermissionRules; getPlayerInformation: CharacterPlayerPermissionRules; getPlayersWithSegment: CharacterPlayerPermissionRules; getPlayersWithTag: CharacterPlayerPermissionRules; getCatalogId: CharacterPlayerPermissionRules; getOwner: CharacterPlayerPermissionRules; getRemoveStatus: CharacterPlayerPermissionRules; getPlayerFriend: CharacterPlayerPermissionRules; getPlayerGroup: CharacterPlayerPermissionRules; getPlayerInventory: CharacterPlayerPermissionRules; removePlayerItem: CharacterPlayerPermissionRules; createPlayerItem: CharacterPlayerPermissionRules; createGroup: CharacterPlayerPermissionRules; joinGroup: CharacterPlayerPermissionRules; leaveGroup: CharacterPlayerPermissionRules; setOwner: CharacterPlayerPermissionRules; addPlayerFriend: CharacterPlayerPermissionRules; removePlayerFriend: CharacterPlayerPermissionRules; getPlayersWithDisplayName: CharacterPlayerPermissionRules; setRemoveStatus: CharacterPlayerPermissionRules; getFriendStatisticsLeaderboardAroundPlayer: CharacterPlayerPermissionRules; getFriendStatisticsLeaderboard: CharacterPlayerPermissionRules; getCurrencyLeaderboard: CharacterPlayerPermissionRules; getCreateLeaderboard: CharacterPlayerPermissionRules; getLastLoginLeaderboard: CharacterPlayerPermissionRules; getStatisticsLog: CharacterPlayerPermissionRules; getCurrencyLog: CharacterPlayerPermissionRules; }; content: { getContentData: ContentPermissionRules; setContentData: ContentPermissionRules; createNewFileUploadInfo: ContentPermissionRules; getFileUploadInfo: ContentPermissionRules; requestDownloadFileUploadInfo: ContentPermissionRules; removeFileUploadInfo: ContentPermissionRules; getFileUploadInfoList: ContentPermissionRules; }; group: { addSegment: GroupPermissionRules; removeSegment: GroupPermissionRules; getSegment: GroupPermissionRules; setTag: GroupPermissionRules; removeTag: GroupPermissionRules; getTag: GroupPermissionRules; getDisplayName: GroupPermissionRules; setDisplayName: GroupPermissionRules; getTsCreate: GroupPermissionRules; setAvatar: GroupPermissionRules; getAvatar: GroupPermissionRules; changeGroupCurrency: GroupPermissionRules; getGroupCurrency: GroupPermissionRules; changeGroupStatistics: GroupPermissionRules; getGroupStatistics: GroupPermissionRules; getStatisticsLeaderboard: GroupPermissionRules; getStatisticsLeaderboardAroundGroup: GroupPermissionRules; getCustomData: GroupPermissionRules; setCustomData: GroupPermissionRules; setGroupData: GroupPermissionRules; getGroupData: GroupPermissionRules; getGroupInformation: GroupPermissionRules; getGroupsWithSegment: GroupPermissionRules; getGroupsWithTag: GroupPermissionRules; getCatalogId: GroupPermissionRules; getRemoveStatus: GroupPermissionRules; getGroupInventory: GroupPermissionRules; removeGroupItem: GroupPermissionRules; createGroupItem: GroupPermissionRules; getMembers: GroupPermissionRules; addMember: GroupPermissionRules; removeMember: GroupPermissionRules; sendGroupMessage: GroupPermissionRules; getGroupMessage: GroupPermissionRules; setRemoveStatus: GroupPermissionRules; getGroupsWithDisplayName: GroupPermissionRules; getCurrencyLeaderboard: GroupPermissionRules; getCreateLeaderboard: GroupPermissionRules; getStatisticsLog: GroupPermissionRules; getCurrencyLog: GroupPermissionRules; }; inventory: { addSegment: InventoryPermissionRules; removeSegment: InventoryPermissionRules; getSegment: InventoryPermissionRules; setTag: InventoryPermissionRules; removeTag: InventoryPermissionRules; getTag: InventoryPermissionRules; getDisplayName: InventoryPermissionRules; setDisplayName: InventoryPermissionRules; getTsCreate: InventoryPermissionRules; setAvatar: InventoryPermissionRules; getAvatar: InventoryPermissionRules; changeItemStatistics: InventoryPermissionRules; getItemStatistics: InventoryPermissionRules; getStatisticsLeaderboard: InventoryPermissionRules; getStatisticsLeaderboardAroundItem: InventoryPermissionRules; getCustomData: InventoryPermissionRules; setCustomData: InventoryPermissionRules; setItemData: InventoryPermissionRules; getItemData: InventoryPermissionRules; getItemInformation: InventoryPermissionRules; getItemsWithSegment: InventoryPermissionRules; getItemsWithTag: InventoryPermissionRules; getCatalogId: InventoryPermissionRules; getClassId: InventoryPermissionRules; getItemType: InventoryPermissionRules; getAmount: InventoryPermissionRules; getOwner: InventoryPermissionRules; getRemoveStatus: InventoryPermissionRules; setAmount: InventoryPermissionRules; setOwner: InventoryPermissionRules; setRemoveStatus: InventoryPermissionRules; getItemsWithDisplayName: InventoryPermissionRules; getCreateLeaderboard: InventoryPermissionRules; getStatisticsLog: InventoryPermissionRules; }; storeInventory: { buyStoreItem: StoreInventoryPermissionRules; getStoreItemInformation: StoreInventoryPermissionRules; getStoreItemsWithTag: StoreInventoryPermissionRules; createStoreItem: StoreInventoryPermissionRules; setRemoveStatus: StoreInventoryPermissionRules; setStoreItemInformation: StoreInventoryPermissionRules; validateAppleAppStoreReceipt: StoreInventoryPermissionRules; validateGooglePlayStoreReceipt: StoreInventoryPermissionRules; validateFacebookStoreReceipt: StoreInventoryPermissionRules; getCreateLeaderboard: StoreInventoryPermissionRules; presentStoreItem: StoreInventoryPermissionRules; getStoreLog: StoreInventoryPermissionRules; getStoreUsed: StoreInventoryPermissionRules; removeStoreUsed: StoreInventoryPermissionRules; }; dashboard: { setMasterGameSettings: DashboardPermissionRules; createAdminAccount: DashboardPermissionRules; removeAdminAccount: DashboardPermissionRules; setPasswordAdminAccount: DashboardPermissionRules; setSecretKeyAdminAccount: DashboardPermissionRules; setGameInformation: DashboardPermissionRules; createGame: DashboardPermissionRules; changePasswordAdminAccount: DashboardPermissionRules; getAdminAccountList: DashboardPermissionRules; getGameInformation: DashboardPermissionRules; getGameList: DashboardPermissionRules; getMasterGameSettings: DashboardPermissionRules; getServerLog: DashboardPermissionRules; getSecretInfoInformation: DashboardPermissionRules; getSecretInfoList: DashboardPermissionRules; createSecretInfo: DashboardPermissionRules; setSecretInfoInformation: DashboardPermissionRules; getUsernameAdminAccount: DashboardPermissionRules; getAnalytics: DashboardPermissionRules; getEventCallbackCloudScript: DashboardPermissionRules; setEventCallbackCloudScript: DashboardPermissionRules; resetStatisticsLeaderboard: DashboardPermissionRules; getBackupStatisticsLeaderboardVersion: DashboardPermissionRules; getServerGameData: DashboardPermissionRules; deleteInDatabase: DashboardPermissionRules; }; multiplayer: { cancelAllMatchmakingTicket: MultiplayerPermissionRules; cancelMatchmakingTicket: MultiplayerPermissionRules; createMatchmakingTicket: MultiplayerPermissionRules; getMatch: MultiplayerPermissionRules; getMatchmakingTicket: MultiplayerPermissionRules; getQueueStatistics: MultiplayerPermissionRules; joinMatchmakingTicket: MultiplayerPermissionRules; listMatchmakingTicketsForPlayer: MultiplayerPermissionRules; getAllMatchmakingTicket: MultiplayerPermissionRules; getAllMatch: MultiplayerPermissionRules; }; cloudScript: { executeFunction: CloudScriptPermissionRules; getFunctions: CloudScriptPermissionRules; addFunction: CloudScriptPermissionRules; editFunction: CloudScriptPermissionRules; getFunction: CloudScriptPermissionRules; }; } declare abstract class BuilderBase { protected secretKey: string; protected remove: boolean; protected tsExpire: number; protected description: string; protected permission: SecretPermissionItem; protected gameId: string; protected isDefault: boolean; protected onlyMasterAdmin: boolean; /** * Returns the secret key. * @returns Returns the secret key. */ getSecretKey(): string; /** * Returns the permission. * @returns Returns the permission. */ getPermission(): SecretPermissionItem; /** * Checks whether remove. * @returns Returns the operation result. */ isRemove(): boolean; /** * Returns the timestamp expire. * @returns Returns the timestamp expire. */ getTsExpire(): number; /** * Returns the description. * @returns Returns the description. */ getDescription(): string; /** * Returns the game ID. * @returns Returns the game ID. */ getGameId(): string; /** * Returns whether default. * @returns Returns whether default. */ getIsDefault(): boolean; /** * Returns whether only master admin. * @returns Returns whether only master admin. */ getIsOnlyMasterAdmin(): boolean; /** * Sets the secret key. * @param secretKey Provides the secret key value used by this operation. * @returns Returns the current builder instance. */ setSecretKey(secretKey: string): Builder; /** * Sets the permission. * @param permission Provides the permission value used by this operation. * @returns Returns the current builder instance. */ setPermission(permission: SecretPermissionItem): Builder; /** * Sets the game ID. * @param gameId Provides the game ID value used by this operation. * @returns Returns the current builder instance. */ setGameId(gameId: string): Builder; /** * Sets whether remove. * @param remove Provides the remove value used by this operation. * @returns Returns the current builder instance. */ setIsRemove(remove: boolean): Builder; /** * Sets whether default. * @param isDefault Indicates whether default. * @returns Returns the current builder instance. */ setIsDefault(isDefault: boolean): Builder; /** * Sets whether only master admin. * @param onlyMasterAdmin Indicates whether only master admin should be allowed. * @returns Returns the current builder instance. */ setIsOnlyMasterAdmin(onlyMasterAdmin: boolean): Builder; /** * Sets the timestamp expire. * @param tsExpire Provides the timestamp expire value used by this operation. * @returns Returns the current builder instance. */ setTsExpire(tsExpire: number): Builder; /** * Sets the description. * @param description Provides the description value used by this operation. * @returns Returns the current builder instance. */ setDescription(description: string): Builder; /** * Builds the configured instance. * @returns Returns the built secret info. */ build(): SecretInfo; /** * Initializes a new builder base instance. */ constructor(); } declare class Builder extends BuilderBase implements IBuilder<SecretInfo> { /** * Sets the secret key. * @param secretKey Provides the secret key value used by this operation. * @returns Returns the current builder instance. */ setSecretKey(secretKey: string): Builder; /** * Sets the timestamp expire. * @param tsExpire Provides the timestamp expire value used by this operation. * @returns Returns the current builder instance. */ setTsExpire(tsExpire: number): Builder; /** * Sets the description. * @param description Provides the description value used by this operation. * @returns Returns the current builder instance. */ setDescription(description: string): Builder; /** * Sets the permission. * @param permission Provides the permission value used by this operation. * @returns Returns the current builder instance. */ setPermission(permission: SecretPermissionItem): Builder; /** * Sets the game ID. * @param gameId Provides the game ID value used by this operation. * @returns Returns the current builder instance. */ setGameId(gameId: string): Builder; /** * Builds the configured instance. * @returns Returns the built secret info. */ build(): SecretInfo; /** * Initializes a new builder instance. */ constructor(); } export declare class SecretInfo extends BuilderBase { /** * Initializes a new secret info instance. * @param builder Provides the builder state copied into this instance. */ constructor(builder: Builder); /** * Sets the game ID. * @param gameId Provides the game ID value used by this operation. * @returns Returns the current builder instance. */ setGameId(gameId: string): Builder; /** * Executes the to document data workflow. */ toDocumentData(): any; /** * Creates a new builder instance. * @returns Returns a new builder instance. */ static Builder(): Builder; } export {};