bungie-net-core/models/Destiny/Entities/Characters/DestinyCharacterActivitiesComponent.d.ts

An easy way to interact with the Bungie.net API

/**
 * 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 { DestinyActivity } from '../../DestinyActivity';
import { DestinyActivityInteractableReference } from '../../Definitions/FireteamFinder/DestinyActivityInteractableReference';
import { DestinyActivityModeType } from '../../HistoricalStats/Definitions/DestinyActivityModeType';
/**
 * This component holds activity data for a character. It will tell you about the
 * character's current activity status, as well as activities that are available to
 * the user.
 * @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Entities.Characters.DestinyCharacterActivitiesComponent}
 */
export interface DestinyCharacterActivitiesComponent {
    /** The last date that the user started playing an activity. */
    readonly dateActivityStarted: string;
    /** The list of activities that the user can play. */
    readonly availableActivities: DestinyActivity[];
    /** The list of activity interactables that the player can interact with. */
    readonly availableActivityInteractables: DestinyActivityInteractableReference[];
    /**
     * If the user is in an activity, this will be the hash of the Activity being
     * played. Note that you must combine this info with currentActivityModeHash to get
     * a real picture of what the user is doing right now. For instance, PVP "
     * Activities" are just maps: it's the ActivityMode that determines what type of
     * PVP game they're playing. Mapped to DestinyActivityDefinition in the manifest.
     */
    readonly currentActivityHash: number;
    /**
     * If the user is in an activity, this will be the hash of the activity mode being
     * played. Combine with currentActivityHash to give a person a full picture of what
     * they're doing right now. Mapped to DestinyActivityModeDefinition in the manifest.
     */
    readonly currentActivityModeHash: number;
    /** And the current activity's most specific mode type, if it can be found. */
    readonly currentActivityModeType?: number;
    /**
     * If the user is in an activity, this will be the hashes of the
     * DestinyActivityModeDefinition being played. Combine with currentActivityHash to
     * give a person a full picture of what they're doing right now. Mapped to
     * DestinyActivityModeDefinition in the manifest.
     */
    readonly currentActivityModeHashes: number[];
    /** All Activity Modes that apply to the current activity being played, in enum form. */
    readonly currentActivityModeTypes: DestinyActivityModeType[];
    /**
     * If the user is in a playlist, this is the hash identifier for the playlist that
     * they chose. Mapped to DestinyActivityDefinition in the manifest.
     */
    readonly currentPlaylistActivityHash?: number;
    /**
     * This will have the activity hash of the last completed story/campaign mission,
     * in case you care about that. Mapped to DestinyActivityDefinition in the manifest.
     */
    readonly lastCompletedStoryHash: number;
}