bungie-net-core
Version:
An easy way to interact with the Bungie.net API
40 lines (39 loc) • 1.78 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 { EMailSettingLocalization } from './EMailSettingLocalization';
import { OptInFlags } from './OptInFlags';
import { EmailSubscriptionDefinition } from './EmailSubscriptionDefinition';
/** @see {@link https://bungie-net.github.io/#/components/schemas/User.EmailViewDefinitionSetting} */
export interface EmailViewDefinitionSetting {
/**
* The identifier for this UI Setting, which can be used to relate it to custom
* strings or other data as desired.
*/
readonly name: string;
/** A dictionary of localized text for the EMail setting, keyed by the locale. */
readonly localization: {
[key: string]: EMailSettingLocalization;
};
/**
* If true, this setting should be set by default if the user hasn't chosen whether
* it's set or cleared yet.
*/
readonly setByDefault: boolean;
/**
* The OptInFlags value to set or clear if this setting is set or cleared in the UI.
* It is the aggregate of all underlying opt-in flags related to this setting.
* This enum represents a set of flags - use bitwise operators to check which of
* these match your value.
*/
readonly optInAggregateValue: OptInFlags;
/** The subscriptions to show as children of this setting, if any. */
readonly subscriptions: EmailSubscriptionDefinition[];
}