Class: PssAllianceHistory

Classes_API~PssAllianceHistory(collectionMetadata, alliance, users)

Represents a snapshot of a PssAlliances (fleets) including information on the Collection and the Alliance's members.

Constructor

new PssAllianceHistory(collectionMetadata, alliance, users)

constructor - Creates an instance of PssAllianceHistory based on the given data.

Parameters:
Name Type Description
collectionMetadata CollectionMetadata

The metadata of the Collection.
alliance PssAlliance

The PssAlliances (fleets) recorded in this PssAllianceHistory.
users Array.<PssUser>

The PssUsers (players) belonging to the Alliance recorded in this PssAllianceHistory. May be empty.
Source:

Members

alliance :PssAlliance

alliance - The PssAlliances (fleets) recorded in this PssAllianceHistory.

Type:
  • PssAlliance
Source:

collection :CollectionMetadata

collection - The metadata of the Collection this PssAllianceHistory is part of.

Type:
  • CollectionMetadata
Source:

users :Array.<PssUser>

users - The members of the PssAlliances (fleets) recorded in this PssAllianceHistory.

Type:
  • Array.<PssUser>
Source:

Methods

(static) fromJson(json)

Creates an instance of PssAllianceHistory from an object parsed from the JSON returned by the PSS Fleet Data API.

Parameters:
Name Type Description
json object

An PssAllianceHistory as parsed from the response of the API.

Properties
Name Type Description
collection object

The metadata of the Collection.
fleet Array

The PssAlliances (fleets) recorded in this PssAllianceHistory.
users Array.<Array>

The PssUsers (players) recorded in this PssAllianceHistory. May be empty. Defaults to an empty array, if not found in the provided JSON.
Source:
Returns:

PssAllianceHistory - An new instance of PssAllianceHistory.