Package com.mojang.realmsclient.client

Class RealmsClient

java.lang.Object

com.mojang.realmsclient.client.RealmsClient

public class RealmsClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RealmsClient.CompatibleVersionResponse
static enum	RealmsClient.Environment

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ACTIVITIES_RESOURCE
static final RealmsClient.Environment	ENVIRONMENT
private static final String	FEATURE_FLAGS_RESOURCE
private final CompletableFuture<Set<String>>	featureFlags
private static final GuardedSerializer	GSON
private static final String	INVITES_RESOURCE_PATH
private static final org.slf4j.Logger	LOGGER
private static final String	MCO_RESOURCE_PATH
private final Minecraft	minecraft
private static final String	NOTIFICATIONS_RESOURCE
private static final String	OPS_RESOURCE
private static final String	PATH_ACCEPT_INVITE
private static final String	PATH_AVAILABLE
private static final String	PATH_CLIENT_COMPATIBLE
private static final String	PATH_CREATE_SNAPSHOT_REALM
private static final String	PATH_DELETE_WORLD
private static final String	PATH_DISMISS_NOTIFICATIONS
private static final String	PATH_GET_ACTIVTIES
private static final String	PATH_GET_LIVESTATS
private static final String	PATH_GET_SUBSCRIPTION
private static final String	PATH_INITIALIZE
private static final String	PATH_LIST_ALL_REALMS
private static final String	PATH_MARK_NOTIFICATIONS_SEEN
private static final String	PATH_NEWS
private static final String	PATH_OP
private static final String	PATH_PENDING_INVITES
private static final String	PATH_PENDING_INVITES_COUNT
private static final String	PATH_PUT_INTO_MINIGAMES_MODE
private static final String	PATH_REJECT_INVITE
private static final String	PATH_SLOT
private static final String	PATH_SNAPSHOT_ELIGIBLE_REALMS
private static final String	PATH_TEMPLATES
private static final String	PATH_TOS_AGREED
private static final String	PATH_UNINVITE_MYSELF
private static final String	PATH_WORLD_BACKUPS
private static final String	PATH_WORLD_CLOSE
private static final String	PATH_WORLD_CONFIGURE
private static final String	PATH_WORLD_DOWNLOAD
private static final String	PATH_WORLD_GET
private static final String	PATH_WORLD_INVITES
private static final String	PATH_WORLD_JOIN
private static final String	PATH_WORLD_OPEN
private static final String	PATH_WORLD_RESET
private static final String	PATH_WORLD_UNINVITE
private static final String	PATH_WORLD_UPLOAD
private static final String	PREFERRED_REGION_RESOURCE
private static RealmsClient	realmsClientInstance
private static final String	REGIONS_RESOURCE
private final String	sessionId
private static final String	SUBSCRIPTION_RESOURCE
private static final String	TRIALS_RESOURCE
private final String	username
private static final String	WORLDS_RESOURCE_PATH

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RealmsClient(String sessionId, String username, Minecraft minecraft)

Method Summary

Modifier and Type	Method	Description
void	acceptInvitation(String inviteId)
void	agreeToTos()
BackupList	backupsFor(long worldId)
RealmsClient.CompatibleVersionResponse	clientCompatible()
Boolean	close(long worldId)
RealmsServer	createSnapshotRealm(Long parentId)
void	deleteRealm(long worldId)
Ops	deop(long worldId, UUID profileUuid)
private String	execute(Request<?> request)
private Set<String>	fetchFeatureFlags()
WorldTemplatePaginatedList	fetchWorldTemplates(int page, int pageSize, RealmsServer.WorldType worldType)
ServerActivityList	getActivity(long worldId)
Set<String>	getFeatureFlags()
RealmsServerPlayerLists	getLiveStats()
RealmsNews	getNews()
List<RealmsNotification>	getNotifications()
static RealmsClient	getOrCreate()
static RealmsClient	getOrCreate(Minecraft minecraft)
RealmsServer	getOwnRealm(long id)
PreferredRegionsDto	getPreferredRegionSelections()
boolean	hasParentalConsent()
void	initializeRealm(long worldId, String name, String description)
List<PlayerInfo>	invite(long worldId, String playerName)
private boolean	isBlocked(PendingInvite pendingInvite)
RealmsJoinInformation	join(long worldId)
RealmsServerList	listRealms()
List<RealmsServer>	listSnapshotEligibleRealms()
void	notificationsDismiss(List<UUID> uuidList)
void	notificationsSeen(List<UUID> uuidList)
Ops	op(long worldId, UUID profileUuid)
Boolean	open(long worldId)
PendingInvitesList	pendingInvites()
int	pendingInvitesCount()
Boolean	putIntoMinigameMode(long worldId, String minigameId)
void	rejectInvitation(String inviteId)
WorldDownload	requestDownloadInfo(long worldId, int slotId)
UploadInfo	requestUploadInfo(long worldId)
Boolean	resetWorldWithTemplate(long worldId, String worldTemplateId)
void	restoreWorld(long worldId, String backupId)
void	sendPingResults(PingResult pingResult)
Subscription	subscriptionFor(long worldId)
boolean	switchSlot(long worldId, int slotId)
Boolean	trialAvailable()
void	uninvite(long worldId, UUID playerUuid)
void	uninviteMyselfFrom(long worldId)
void	updateConfiguration(long worldId, String name, String description, RegionSelectionPreferenceDto regionSettings, int slotId, RealmsWorldOptions options, List<RealmsSetting> settings)
void	updateSlot(long worldId, int slotId, RealmsWorldOptions options, List<RealmsSetting> settings)
private String	url(String path)
private String	url(String path, String query)
private static String	url(String path, String query, boolean useAlternativeUrl)
private static JsonArray	uuidListToJsonArray(List<UUID> uuidList)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ENVIRONMENT

public static final RealmsClient.Environment ENVIRONMENT

LOGGER

private static final org.slf4j.Logger LOGGER

realmsClientInstance

@Nullable
private static volatile RealmsClient realmsClientInstance

featureFlags

private final CompletableFuture<Set<String>> featureFlags

sessionId

private final String sessionId

username

private final String username

minecraft

private final Minecraft minecraft

WORLDS_RESOURCE_PATH

private static final String WORLDS_RESOURCE_PATH

See Also:

• Constant Field Values

INVITES_RESOURCE_PATH

private static final String INVITES_RESOURCE_PATH

See Also:

• Constant Field Values

MCO_RESOURCE_PATH

private static final String MCO_RESOURCE_PATH

See Also:

• Constant Field Values

SUBSCRIPTION_RESOURCE

private static final String SUBSCRIPTION_RESOURCE

See Also:

• Constant Field Values

ACTIVITIES_RESOURCE

private static final String ACTIVITIES_RESOURCE

See Also:

• Constant Field Values

OPS_RESOURCE

private static final String OPS_RESOURCE

See Also:

• Constant Field Values

REGIONS_RESOURCE

private static final String REGIONS_RESOURCE

See Also:

• Constant Field Values

PREFERRED_REGION_RESOURCE

private static final String PREFERRED_REGION_RESOURCE

See Also:

• Constant Field Values

TRIALS_RESOURCE

private static final String TRIALS_RESOURCE

See Also:

• Constant Field Values

NOTIFICATIONS_RESOURCE

private static final String NOTIFICATIONS_RESOURCE

See Also:

• Constant Field Values

FEATURE_FLAGS_RESOURCE

private static final String FEATURE_FLAGS_RESOURCE

See Also:

• Constant Field Values

PATH_LIST_ALL_REALMS

private static final String PATH_LIST_ALL_REALMS

See Also:

• Constant Field Values

PATH_CREATE_SNAPSHOT_REALM

private static final String PATH_CREATE_SNAPSHOT_REALM

See Also:

• Constant Field Values

PATH_SNAPSHOT_ELIGIBLE_REALMS

private static final String PATH_SNAPSHOT_ELIGIBLE_REALMS

See Also:

• Constant Field Values

PATH_INITIALIZE

private static final String PATH_INITIALIZE

See Also:

• Constant Field Values

PATH_GET_ACTIVTIES

private static final String PATH_GET_ACTIVTIES

See Also:

• Constant Field Values

PATH_GET_LIVESTATS

private static final String PATH_GET_LIVESTATS

See Also:

• Constant Field Values

PATH_GET_SUBSCRIPTION

private static final String PATH_GET_SUBSCRIPTION

See Also:

• Constant Field Values

PATH_OP

private static final String PATH_OP

See Also:

• Constant Field Values

PATH_PUT_INTO_MINIGAMES_MODE

private static final String PATH_PUT_INTO_MINIGAMES_MODE

See Also:

• Constant Field Values

PATH_AVAILABLE

private static final String PATH_AVAILABLE

See Also:

• Constant Field Values

PATH_TEMPLATES

private static final String PATH_TEMPLATES

See Also:

• Constant Field Values

PATH_WORLD_JOIN

private static final String PATH_WORLD_JOIN

See Also:

• Constant Field Values

PATH_WORLD_GET

private static final String PATH_WORLD_GET

See Also:

• Constant Field Values

PATH_WORLD_INVITES

private static final String PATH_WORLD_INVITES

See Also:

• Constant Field Values

PATH_WORLD_UNINVITE

private static final String PATH_WORLD_UNINVITE

See Also:

• Constant Field Values

PATH_PENDING_INVITES_COUNT

private static final String PATH_PENDING_INVITES_COUNT

See Also:

• Constant Field Values

PATH_PENDING_INVITES

private static final String PATH_PENDING_INVITES

See Also:

• Constant Field Values

PATH_ACCEPT_INVITE

private static final String PATH_ACCEPT_INVITE

See Also:

• Constant Field Values

PATH_REJECT_INVITE

private static final String PATH_REJECT_INVITE

See Also:

• Constant Field Values

PATH_UNINVITE_MYSELF

private static final String PATH_UNINVITE_MYSELF

See Also:

• Constant Field Values

PATH_WORLD_CONFIGURE

private static final String PATH_WORLD_CONFIGURE

See Also:

• Constant Field Values

PATH_SLOT

private static final String PATH_SLOT

See Also:

• Constant Field Values

PATH_WORLD_OPEN

private static final String PATH_WORLD_OPEN

See Also:

• Constant Field Values

PATH_WORLD_CLOSE

private static final String PATH_WORLD_CLOSE

See Also:

• Constant Field Values

PATH_WORLD_RESET

private static final String PATH_WORLD_RESET

See Also:

• Constant Field Values

PATH_DELETE_WORLD

private static final String PATH_DELETE_WORLD

See Also:

• Constant Field Values

PATH_WORLD_BACKUPS

private static final String PATH_WORLD_BACKUPS

See Also:

• Constant Field Values

PATH_WORLD_DOWNLOAD

private static final String PATH_WORLD_DOWNLOAD

See Also:

• Constant Field Values

PATH_WORLD_UPLOAD

private static final String PATH_WORLD_UPLOAD

See Also:

• Constant Field Values

PATH_CLIENT_COMPATIBLE

private static final String PATH_CLIENT_COMPATIBLE

See Also:

• Constant Field Values

PATH_TOS_AGREED

private static final String PATH_TOS_AGREED

See Also:

• Constant Field Values

PATH_NEWS

private static final String PATH_NEWS

See Also:

• Constant Field Values

PATH_MARK_NOTIFICATIONS_SEEN

private static final String PATH_MARK_NOTIFICATIONS_SEEN

See Also:

• Constant Field Values

PATH_DISMISS_NOTIFICATIONS

private static final String PATH_DISMISS_NOTIFICATIONS

See Also:

• Constant Field Values

GSON

private static final GuardedSerializer GSON

Constructor Details

RealmsClient

private RealmsClient(String sessionId,
 String username,
 Minecraft minecraft)

Method Details

getOrCreate

public static RealmsClient getOrCreate()

getOrCreate

public static RealmsClient getOrCreate(Minecraft minecraft)

getFeatureFlags

public Set<String> getFeatureFlags()

fetchFeatureFlags

private Set<String> fetchFeatureFlags()

listRealms

public RealmsServerList listRealms()
                            throws RealmsServiceException

Throws:

RealmsServiceException

listSnapshotEligibleRealms

public List<RealmsServer> listSnapshotEligibleRealms()
                                              throws RealmsServiceException

Throws:

RealmsServiceException

createSnapshotRealm

public RealmsServer createSnapshotRealm(Long parentId)
                                 throws RealmsServiceException

Throws:

RealmsServiceException

getNotifications

public List<RealmsNotification> getNotifications()
                                          throws RealmsServiceException

Throws:

RealmsServiceException

uuidListToJsonArray

private static JsonArray uuidListToJsonArray(List<UUID> uuidList)

notificationsSeen

public void notificationsSeen(List<UUID> uuidList)
                       throws RealmsServiceException

Throws:

RealmsServiceException

notificationsDismiss

public void notificationsDismiss(List<UUID> uuidList)
                          throws RealmsServiceException

Throws:

RealmsServiceException

getOwnRealm

public RealmsServer getOwnRealm(long id)
                         throws RealmsServiceException

Throws:

RealmsServiceException

getPreferredRegionSelections

public PreferredRegionsDto getPreferredRegionSelections()
                                                 throws RealmsServiceException

Throws:

RealmsServiceException

getActivity

public ServerActivityList getActivity(long worldId)
                               throws RealmsServiceException

Throws:

RealmsServiceException

getLiveStats

public RealmsServerPlayerLists getLiveStats()
                                     throws RealmsServiceException

Throws:

RealmsServiceException

join

public RealmsJoinInformation join(long worldId)
                           throws RealmsServiceException

Throws:

RealmsServiceException

initializeRealm

public void initializeRealm(long worldId,
 String name,
 String description)
                     throws RealmsServiceException

Throws:

RealmsServiceException

hasParentalConsent

public boolean hasParentalConsent()
                           throws RealmsServiceException

Throws:

RealmsServiceException

clientCompatible

public RealmsClient.CompatibleVersionResponse clientCompatible()
                                                        throws RealmsServiceException

Throws:

RealmsServiceException

uninvite

public void uninvite(long worldId,
 UUID playerUuid)
              throws RealmsServiceException

Throws:

RealmsServiceException

uninviteMyselfFrom

public void uninviteMyselfFrom(long worldId)
                        throws RealmsServiceException

Throws:

RealmsServiceException

invite

public List<PlayerInfo> invite(long worldId,
 String playerName)
                        throws RealmsServiceException

Throws:

RealmsServiceException

backupsFor

public BackupList backupsFor(long worldId)
                      throws RealmsServiceException

Throws:

RealmsServiceException

updateConfiguration

public void updateConfiguration(long worldId,
 String name,
 String description,
 @Nullable
 RegionSelectionPreferenceDto regionSettings,
 int slotId,
 RealmsWorldOptions options,
 List<RealmsSetting> settings)
                         throws RealmsServiceException

Throws:

RealmsServiceException

updateSlot

public void updateSlot(long worldId,
 int slotId,
 RealmsWorldOptions options,
 List<RealmsSetting> settings)
                throws RealmsServiceException

Throws:

RealmsServiceException

switchSlot

public boolean switchSlot(long worldId,
 int slotId)
                   throws RealmsServiceException

Throws:

RealmsServiceException

restoreWorld

public void restoreWorld(long worldId,
 String backupId)
                  throws RealmsServiceException

Throws:

RealmsServiceException

fetchWorldTemplates

public WorldTemplatePaginatedList fetchWorldTemplates(int page,
 int pageSize,
 RealmsServer.WorldType worldType)
                                               throws RealmsServiceException

Throws:

RealmsServiceException

putIntoMinigameMode

public Boolean putIntoMinigameMode(long worldId,
 String minigameId)
                            throws RealmsServiceException

Throws:

RealmsServiceException

op

public Ops op(long worldId,
 UUID profileUuid)
       throws RealmsServiceException

Throws:

RealmsServiceException

deop

public Ops deop(long worldId,
 UUID profileUuid)
         throws RealmsServiceException

Throws:

RealmsServiceException

open

public Boolean open(long worldId)
             throws RealmsServiceException

Throws:

RealmsServiceException

close

public Boolean close(long worldId)
              throws RealmsServiceException

Throws:

RealmsServiceException

resetWorldWithTemplate

public Boolean resetWorldWithTemplate(long worldId,
 String worldTemplateId)
                               throws RealmsServiceException

Throws:

RealmsServiceException

subscriptionFor

public Subscription subscriptionFor(long worldId)
                             throws RealmsServiceException

Throws:

RealmsServiceException

pendingInvitesCount

public int pendingInvitesCount()
                        throws RealmsServiceException

Throws:

RealmsServiceException

pendingInvites

public PendingInvitesList pendingInvites()
                                  throws RealmsServiceException

Throws:

RealmsServiceException

isBlocked

private boolean isBlocked(PendingInvite pendingInvite)

acceptInvitation

public void acceptInvitation(String inviteId)
                      throws RealmsServiceException

Throws:

RealmsServiceException

requestDownloadInfo

public WorldDownload requestDownloadInfo(long worldId,
 int slotId)
                                  throws RealmsServiceException

Throws:

RealmsServiceException

requestUploadInfo

@Nullable
public UploadInfo requestUploadInfo(long worldId)
                             throws RealmsServiceException

Throws:

RealmsServiceException

rejectInvitation

public void rejectInvitation(String inviteId)
                      throws RealmsServiceException

Throws:

RealmsServiceException

agreeToTos

public void agreeToTos()
                throws RealmsServiceException

Throws:

RealmsServiceException

getNews

public RealmsNews getNews()
                   throws RealmsServiceException

Throws:

RealmsServiceException

sendPingResults

public void sendPingResults(PingResult pingResult)
                     throws RealmsServiceException

Throws:

RealmsServiceException

trialAvailable

public Boolean trialAvailable()
                       throws RealmsServiceException

Throws:

RealmsServiceException

deleteRealm

public void deleteRealm(long worldId)
                 throws RealmsServiceException

Throws:

RealmsServiceException

url

private String url(String path)
            throws RealmsServiceException

Throws:

RealmsServiceException

url

private String url(String path,
 @Nullable
 String query)
            throws RealmsServiceException

Throws:

RealmsServiceException

url

private static String url(String path,
 @Nullable
 String query,
 boolean useAlternativeUrl)

execute

private String execute(Request<?> request)
                throws RealmsServiceException

Throws:

RealmsServiceException