Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents the party information for a specific player

Hierarchy

Index

Constructors

Properties

apiVersion: `${number}.${number}.${number}`

The version of the requested API route

libVersion: `${number}.${number}.${number}`

The version of the representation of the data by the wrapper

The members of the player's party. This includes all guild members and friends currently logged into the same world, along with all party members of the player, regardless of whether they share a world.

The connected player themselves is not included in this list.
requestedAt: number

The unix timestamp indicating when this request started executing

respondedAt: number

The unix timestamp indicating when this request was responded to

You can use this value in combination with timestamp to see how old the data is
If the response was returned from cache or the response took a long time to transmit, then this isn't a reliable way to determine the age of data.

The player to whom this request is bound

The route used to request the data for this object

This is the value used to identify cache entries. API results with the same source can use the cache.
timestamp: number

The unix timestamp indicating when the data of this request was last updated

This stat does not reflect the time this data was created, but when the API frontend last synced this data. The PvP leaderboard, for instance, updates once per hour. Yet this timestamp will update once every 30 seconds.
world: string

The world the player is currently logged into

Generated using TypeDoc