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 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_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_UPDATE

private static final String

PATH_WORLD_UPLOAD

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

Constructor

Description

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)

static RealmsClient

create()

static RealmsClient

create(Minecraft minecraft)

RealmsServer

createSnapshotRealm(Long parentId)

void

deleteRealm(long worldId)

Ops

deop(long worldId, UUID profileUuid)

private String

execute(Request<?> request)

WorldTemplatePaginatedList

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

ServerActivityList

getActivity(long worldId)

RealmsServerPlayerLists

getLiveStats()

RealmsNews

getNews()

List<RealmsNotification>

getNotifications()

RealmsServer

getOwnRealm(long id)

boolean

hasParentalConsent()

void

initializeRealm(long worldId, String name, String description)

RealmsServer

invite(long worldId, String playerName)

private boolean

isBlocked(PendingInvite pendingInvite)

RealmsServerAddress

join(long serverId)

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, String token)

Boolean

resetWorldWithSeed(long worldId, WorldGenerationInfo generationInfo)

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

update(long worldId, String name, String description)

void

updateSlot(long worldId, int slotId, RealmsWorldOptions worldOptions)

private String

url(String path)

private String

url(String path, String query)

private static com.google.gson.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
- 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
- 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
- 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_UPDATE
  
  private static final String PATH_WORLD_UPDATE
  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
  
  public RealmsClient(String sessionId, String username, Minecraft minecraft)
Method Details
- create
  
  public static RealmsClient create()
- create
  
  public static RealmsClient create(Minecraft minecraft)
- 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> 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
- getActivity
  
  public ServerActivityList getActivity(long worldId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- getLiveStats
  
  public RealmsServerPlayerLists getLiveStats() throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- join
  
  public RealmsServerAddress join(long serverId) 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 RealmsServer invite(long worldId, String playerName) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- backupsFor
  
  public BackupList backupsFor(long worldId) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- update
  
  public void update(long worldId, String name, String description) throws RealmsServiceException
  
  Throws:
  
  RealmsServiceException
- updateSlot
  
  public void updateSlot(long worldId, int slotId, RealmsWorldOptions worldOptions) 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
- resetWorldWithSeed
  
  public Boolean resetWorldWithSeed(long worldId, WorldGenerationInfo generationInfo) 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, @Nullable String token) 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)
- url
  
  private String url(String path, @Nullable String query)
- 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 java.lang.Object

Field Details

ENVIRONMENT

LOGGER

sessionId

username

minecraft

WORLDS_RESOURCE_PATH

INVITES_RESOURCE_PATH

MCO_RESOURCE_PATH

SUBSCRIPTION_RESOURCE

ACTIVITIES_RESOURCE

OPS_RESOURCE

REGIONS_RESOURCE

TRIALS_RESOURCE

NOTIFICATIONS_RESOURCE

PATH_LIST_ALL_REALMS

PATH_CREATE_SNAPSHOT_REALM

PATH_SNAPSHOT_ELIGIBLE_REALMS

PATH_INITIALIZE

PATH_GET_ACTIVTIES

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_COUNT

PATH_PENDING_INVITES

PATH_ACCEPT_INVITE

PATH_REJECT_INVITE

PATH_UNINVITE_MYSELF

PATH_WORLD_UPDATE

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

create

create

listRealms

listSnapshotEligibleRealms

createSnapshotRealm

getNotifications

uuidListToJsonArray

notificationsSeen

notificationsDismiss

getOwnRealm

getActivity

getLiveStats

join

initializeRealm

hasParentalConsent

clientCompatible

uninvite

uninviteMyselfFrom

invite

backupsFor

update