bungie-net-core/models/User/UserInfoCard.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 { BungieMembershipType } from '../BungieMembershipType';
/**
 * This contract supplies basic information commonly used to display a minimal
 * amount of information about a user. Take care to not add more properties here
 * unless the property applies in all (or at least the majority) of the situations
 * where UserInfoCard is used. Avoid adding game specific or platform specific
 * details here. In cases where UserInfoCard is a subset of the data needed in a
 * contract, use UserInfoCard as a property of other contracts.
 * @see {@link https://bungie-net.github.io/#/components/schemas/User.UserInfoCard}
 */
export interface UserInfoCard {
    /**
     * A platform specific additional display name - ex: psn Real Name, bnet Unique
     * Name, etc.
     */
    readonly supplementalDisplayName: string;
    /** URL the Icon if available. */
    readonly iconPath: string;
    /**
     * If there is a cross save override in effect, this value will tell you the type
     * that is overridding this one.
     */
    readonly crossSaveOverride: BungieMembershipType;
    /**
     * The list of Membership Types indicating the platforms on which this Membership
     * can be used.
     *
     * Not in Cross Save = its original membership type. Cross Save Primary = Any
     * membership types it is overridding, and its original membership type Cross Save
     * Overridden = Empty list
     */
    readonly applicableMembershipTypes: BungieMembershipType[];
    /** If True, this is a public user membership. */
    readonly isPublic: boolean;
    /** Type of the membership. Not necessarily the native type. */
    readonly membershipType: BungieMembershipType;
    /** Membership ID as they user is known in the Accounts service */
    readonly membershipId: string;
    /**
     * Display Name the player has chosen for themselves. The display name is optional
     * when the data type is used as input to a platform API.
     */
    readonly displayName: string;
    /** The bungie global display name, if set. */
    readonly bungieGlobalDisplayName: string;
    /** The bungie global display name code, if set. */
    readonly bungieGlobalDisplayNameCode?: number;
}