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_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_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 @Nullable 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 invitationId)

void

agreeToTos()

BackupList

backupsFor(long realmId)

RealmsClient.CompatibleVersionResponse

clientCompatible()

Boolean

close(long realmId)

RealmsServer

createSnapshotRealm(Long parentId)

void

deleteRealm(long realmId)

Ops

deop(long realmId, UUID profileId)

private String

execute(Request<?> request)

private Set<String>

fetchFeatureFlags()

WorldTemplatePaginatedList

fetchWorldTemplates(int page, int pageSize, RealmsServer.WorldType type)

Set<String>

getFeatureFlags()

RealmsServerPlayerLists

getLiveStats()

RealmsNews

getNews()

List<RealmsNotification>

getNotifications()

static RealmsClient

getOrCreate()

static RealmsClient

getOrCreate(Minecraft minecraft)

RealmsServer

getOwnRealm(long realmId)

PreferredRegionsDto

getPreferredRegionSelections()

boolean

hasParentalConsent()

void

initializeRealm(long realmId, String name, String motd)

List<PlayerInfo>

invite(long realmId, String profileName)

private boolean

isBlocked(PendingInvite invite)

RealmsJoinInformation

join(long realmId)

RealmsServerList

listRealms()

List<RealmsServer>

listSnapshotEligibleRealms()

void

notificationsDismiss(List<UUID> notificationUuids)

void

notificationsSeen(List<UUID> notificationUuids)

Ops

op(long realmId, UUID profileId)

Boolean

open(long realmId)

PendingInvitesList

pendingInvites()

int

pendingInvitesCount()

Boolean

putIntoMinigameMode(long realmId, String minigameId)

void

rejectInvitation(String invitationId)

WorldDownload

requestDownloadInfo(long realmId, int slotId)

@Nullable UploadInfo

requestUploadInfo(long realmId)

Boolean

resetWorldWithTemplate(long realmId, String worldTemplateId)

void

restoreWorld(long realmId, String backupId)

void

sendPingResults(PingResult pingResult)

Subscription

subscriptionFor(long realmId)

boolean

switchSlot(long realmId, int slot)

Boolean

trialAvailable()

void

uninvite(long realmId, UUID profileId)

void

uninviteMyselfFrom(long realmId)

void

updateConfiguration(long realmId, String name, String description, @Nullable RegionSelectionPreferenceDto regionSelectionPreference, int slotId, RealmsWorldOptions options, List<RealmsSetting> settings)

void

updateSlot(long realmId, int slotId, RealmsWorldOptions options, List<RealmsSetting> settings)

private String

url(String path)

private String

url(String path, @Nullable String queryString)

private static String

url(String path, @Nullable String queryString, boolean useAlternativeURL)

private static com.google.gson.JsonArray

uuidListToJsonArray(List<UUID> uuids)

Methods inherited from class 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
  
  private static volatile @Nullable 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_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
  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 com.google.gson.JsonArray uuidListToJsonArray(List<UUID> uuids)
- notificationsSeen
  
  public void notificationsSeen(List<UUID> notificationUuids) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- notificationsDismiss
  
  public void notificationsDismiss(List<UUID> notificationUuids) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- getOwnRealm
  
  public RealmsServer getOwnRealm(long realmId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- getPreferredRegionSelections
  
  public PreferredRegionsDto getPreferredRegionSelections() throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- getLiveStats
  
  public RealmsServerPlayerLists getLiveStats() throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- join
  
  public RealmsJoinInformation join(long realmId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- initializeRealm
  
  public void initializeRealm(long realmId, String name, String motd) 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 realmId, UUID profileId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- uninviteMyselfFrom
  
  public void uninviteMyselfFrom(long realmId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- invite
  
  public List<PlayerInfo> invite(long realmId, String profileName) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- backupsFor
  
  public BackupList backupsFor(long realmId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- updateConfiguration
  
  public void updateConfiguration(long realmId, String name, String description, @Nullable RegionSelectionPreferenceDto regionSelectionPreference, int slotId, RealmsWorldOptions options, List<RealmsSetting> settings) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- updateSlot
  
  public void updateSlot(long realmId, int slotId, RealmsWorldOptions options, List<RealmsSetting> settings) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- switchSlot
  
  public boolean switchSlot(long realmId, int slot) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- restoreWorld
  
  public void restoreWorld(long realmId, String backupId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- fetchWorldTemplates
  
  public WorldTemplatePaginatedList fetchWorldTemplates(int page, int pageSize, RealmsServer.WorldType type) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- putIntoMinigameMode
  
  public Boolean putIntoMinigameMode(long realmId, String minigameId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- op
  
  public Ops op(long realmId, UUID profileId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- deop
  
  public Ops deop(long realmId, UUID profileId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- open
  
  public Boolean open(long realmId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- close
  
  public Boolean close(long realmId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- resetWorldWithTemplate
  
  public Boolean resetWorldWithTemplate(long realmId, String worldTemplateId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- subscriptionFor
  
  public Subscription subscriptionFor(long realmId) 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 invite)
- acceptInvitation
  
  public void acceptInvitation(String invitationId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- requestDownloadInfo
  
  public WorldDownload requestDownloadInfo(long realmId, int slotId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- requestUploadInfo
  
  public @Nullable UploadInfo requestUploadInfo(long realmId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- rejectInvitation
  
  public void rejectInvitation(String invitationId) 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 realmId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- url
  
  private String url(String path) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- url
  
  private String url(String path, @Nullable String queryString)
- url
  
  private static String url(String path, @Nullable String queryString, boolean useAlternativeURL)
- execute
  
  private String execute(Request<?> request) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException

Class RealmsClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Details

ENVIRONMENT

LOGGER

realmsClientInstance

featureFlags

sessionId

username

minecraft

WORLDS_RESOURCE_PATH

INVITES_RESOURCE_PATH

MCO_RESOURCE_PATH

SUBSCRIPTION_RESOURCE

ACTIVITIES_RESOURCE

OPS_RESOURCE

REGIONS_RESOURCE

PREFERRED_REGION_RESOURCE

TRIALS_RESOURCE

NOTIFICATIONS_RESOURCE

FEATURE_FLAGS_RESOURCE

PATH_LIST_ALL_REALMS

PATH_CREATE_SNAPSHOT_REALM

PATH_SNAPSHOT_ELIGIBLE_REALMS

PATH_INITIALIZE

PATH_GET_LIVESTATS

PATH_GET_SUBSCRIPTION

PATH_OP

PATH_PUT_INTO_MINIGAMES_MODE

PATH_AVAILABLE

PATH_TEMPLATES

PATH_WORLD_JOIN

PATH_WORLD_GET

PATH_WORLD_INVITES

PATH_WORLD_UNINVITE

PATH_PENDING_INVITES

PATH_ACCEPT_INVITE

PATH_REJECT_INVITE

PATH_UNINVITE_MYSELF

PATH_WORLD_CONFIGURE

PATH_SLOT

PATH_WORLD_OPEN

PATH_WORLD_CLOSE

PATH_WORLD_RESET

PATH_DELETE_WORLD

PATH_WORLD_BACKUPS

PATH_WORLD_DOWNLOAD

PATH_WORLD_UPLOAD

PATH_CLIENT_COMPATIBLE

PATH_TOS_AGREED

PATH_NEWS

PATH_MARK_NOTIFICATIONS_SEEN

PATH_DISMISS_NOTIFICATIONS

GSON

Constructor Details

RealmsClient

Method Details

getOrCreate

getOrCreate

getFeatureFlags

fetchFeatureFlags

listRealms

listSnapshotEligibleRealms

createSnapshotRealm

getNotifications

uuidListToJsonArray

notificationsSeen

notificationsDismiss

getOwnRealm

getPreferredRegionSelections

getLiveStats

join

initializeRealm

hasParentalConsent

clientCompatible

uninvite