bungie-net-core/models/Destiny/Definitions/Social/DestinySocialCommendationNodeDefinition.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 { DestinyDisplayPropertiesDefinition } from '../Common/DestinyDisplayPropertiesDefinition';
import { DestinyColor } from '../../Misc/DestinyColor';
/** @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Definitions.Social.DestinySocialCommendationNodeDefinition} */
export interface DestinySocialCommendationNodeDefinition {
    readonly displayProperties: DestinyDisplayPropertiesDefinition;
    /** The color associated with this group of commendations. */
    readonly color: DestinyColor;
    /** A version of the displayProperties icon tinted with the color of this node. */
    readonly tintedIcon: string;
    /** Mapped to DestinySocialCommendationNodeDefinition in the manifest. */
    readonly parentCommendationNodeHash: number;
    /**
     * A list of hashes that map to child commendation nodes. Only the root
     * commendations node is expected to have child nodes. Mapped to
     * DestinySocialCommendationNodeDefinition in the manifest.
     */
    readonly childCommendationNodeHashes: number[];
    /**
     * A list of hashes that map to child commendations. Mapped to
     * DestinySocialCommendationDefinition in the manifest.
     */
    readonly childCommendationHashes: number[];
    /**
     * The unique identifier for this entity. Guaranteed to be unique for the type of
     * entity, but not globally.
     *
     * When entities refer to each other in Destiny content, it is this hash that they
     * are referring to.
     */
    readonly hash: number;
    /** The index of the entity as it was found in the investment tables. */
    readonly index: number;
    /**
     * If this is true, then there is an entity with this identifier/type combination,
     * but BNet is not yet allowed to show it. Sorry!
     */
    readonly redacted: boolean;
}