bungie-net-core
Version:
An easy way to interact with the Bungie.net API
42 lines (41 loc) • 2.08 kB
TypeScript
/**
* Bungie.Net API
* These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
*
* Contact: support@bungie.com
*
* NOTE: This class is auto generated by the bungie-net-core code generator program
* Repository: {@link https://github.com/owens1127/bungie-net-core}
* Do not edit these files manually.
*/
import { DestinyPartyMemberStates } from '../../DestinyPartyMemberStates';
/**
* This is some bare minimum information about a party member in a Fireteam.
* Unfortunately, without great computational expense on our side we can only get
* at the data contained here. I'd like to give you a character ID for example, but
* we don't have it. But we do have these three pieces of information. May they
* help you on your quest to show meaningful data about current Fireteams.
*
* Notably, we don't and can't feasibly return info on characters. If you can, try
* to use just the data below for your UI and purposes. Only hit us with further
* queries if you absolutely must know the character ID of the currently playing
* character. Pretty please with sugar on top.
* @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Components.Profiles.DestinyProfileTransitoryPartyMember}
*/
export interface DestinyProfileTransitoryPartyMember {
/** The Membership ID that matches the party member. */
readonly membershipId: string;
/**
* The identifier for the DestinyInventoryItemDefinition of the player's emblem.
* Mapped to DestinyInventoryItemDefinition in the manifest.
*/
readonly emblemHash: number;
/** The player's last known display name. */
readonly displayName: string;
/**
* A Flags Enumeration value indicating the states that the player is in relevant
* to being on a fireteam. This enum represents a set of flags - use bitwise
* operators to check which of these match your value.
*/
readonly status: DestinyPartyMemberStates;
}