Destiny2 class

Constructors

Destiny2()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

awaGetActionToken(HttpClient client, String correlationId) Future<AwaAuthorizationResultResponse>
Returns the action token if user approves the request.
awaInitializeRequest(HttpClient client, AwaPermissionRequested body) Future<AwaInitializeResponseResponse>
Initialize a request to perform an advanced write action.
awaProvideAuthorizationResult(HttpClient client, AwaUserResponse body) Future<Int32Response>
Provide the result of the user interaction. Called by the Bungie Destiny App to approve or reject a request.
clearLoadout(HttpClient client, DestinyLoadoutActionRequest body) Future<Int32Response>
Clear the identifiers and items of a loadout.
equipItem(HttpClient client, DestinyItemActionRequest body) Future<Int32Response>
Equip an item. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.
equipItems(HttpClient client, DestinyItemSetActionRequest body) Future<DestinyEquipItemResultsResponse>
Equip a list of items by itemInstanceIds. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline. Any items not found on your character will be ignored.
equipLoadout(HttpClient client, DestinyLoadoutActionRequest body) Future<Int32Response>
Equip a loadout. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline.
getActivityHistory(HttpClient client, String characterId, int count, String destinyMembershipId, BungieMembershipType membershipType, DestinyActivityModeType mode, int page) Future<DestinyActivityHistoryResultsResponse>
Gets activity history stats for indicated character.
getCharacter(HttpClient client, String characterId, List<DestinyComponentType> components, String destinyMembershipId, BungieMembershipType membershipType) Future<DestinyCharacterResponseResponse>
Returns character information for the supplied character.
getClanAggregateStats(HttpClient client, String groupId, String modes) Future<ListOfDestinyClanAggregateStatResponse>
Gets aggregated stats for a clan using the same categories as the clan leaderboards. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.
getClanBannerSource(HttpClient client) Future<ClanBannerSourceResponse>
Returns the dictionary of values for the Clan Banner
getClanLeaderboards(HttpClient client, String groupId, int maxtop, String modes, String statid) Future<DestinyLeaderboardResultsResponse>
Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.
getClanWeeklyRewardState(HttpClient client, String groupId) Future<DestinyMilestoneResponse>
Returns information on the weekly clan rewards and if the clan has earned them or not. Note that this will always report rewards as not redeemed.
getCollectibleNodeDetails(HttpClient client, String characterId, int collectiblePresentationNodeHash, List<DestinyComponentType> components, String destinyMembershipId, BungieMembershipType membershipType) Future<DestinyCollectibleNodeDetailResponseResponse>
Given a Presentation Node that has Collectibles as direct descendants, this will return item details about those descendants in the context of the requesting character.
getDestinyAggregateActivityStats(HttpClient client, String characterId, String destinyMembershipId, BungieMembershipType membershipType) Future<DestinyAggregateActivityResultsResponse>
Gets all activities the character has participated in together with aggregate statistics for those activities.
getDestinyEntityDefinition(HttpClient client, String entityType, int hashIdentifier) Future<DestinyDefinitionResponse>
Returns the static definition of an entity of the given Type and hash identifier. Examine the API Documentation for the Type Names of entities that have their own definitions. Note that the return type will always inherit from DestinyDefinition, but the specific type returned will be the requested entity type if it can be found. Please don't use this as a chatty alternative to the Manifest database if you require large sets of data, but for simple and one-off accesses this should be handy.
getDestinyManifest(HttpClient client) Future<DestinyManifestResponse>
Returns the current version of the manifest as a json object.
getHistoricalStats(HttpClient client, String characterId, String dayend, String daystart, String destinyMembershipId, List<DestinyStatsGroupType> groups, BungieMembershipType membershipType, List<DestinyActivityModeType> modes, PeriodType periodType) Future<DestinyHistoricalStatsResultsResponse>
Gets historical stats for indicated character.
getHistoricalStatsDefinition(HttpClient client) Future<ReadOnlyDictionaryOfstringAndDestinyHistoricalStatsDefinitionResponse>
Gets historical stats definitions.
getHistoricalStatsForAccount(HttpClient client, String destinyMembershipId, List<DestinyStatsGroupType> groups, BungieMembershipType membershipType) Future<DestinyHistoricalStatsAccountResultResponse>
Gets aggregate historical stats organized around each character for a given account.
getItem(HttpClient client, List<DestinyComponentType> components, String destinyMembershipId, String itemInstanceId, BungieMembershipType membershipType) Future<DestinyItemResponseResponse>
Retrieve the details of an instanced Destiny Item. An instanced Destiny item is one with an ItemInstanceId. Non-instanced items, such as materials, have no useful instance-specific details and thus are not queryable here.
getLeaderboards(HttpClient client, String destinyMembershipId, int maxtop, BungieMembershipType membershipType, String modes, String statid) Future<DestinyLeaderboardResultsResponse>
Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint has not yet been implemented. It is being returned for a preview of future functionality, and for public comment/suggestion/preparation.
getLeaderboardsForCharacter(HttpClient client, String characterId, String destinyMembershipId, int maxtop, BungieMembershipType membershipType, String modes, String statid) Future<DestinyLeaderboardResultsResponse>
Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.
getLinkedProfiles(HttpClient client, bool getAllMemberships, String membershipId, BungieMembershipType membershipType) Future<DestinyLinkedProfilesResponseResponse>
Returns a summary information about all profiles linked to the requesting membership type/membership ID that have valid Destiny information. The passed-in Membership Type/Membership ID may be a Bungie.Net membership or a Destiny membership. It only returns the minimal amount of data to begin making more substantive requests, but will hopefully serve as a useful alternative to UserServices for people who just care about Destiny data. Note that it will only return linked accounts whose linkages you are allowed to view.
getPostGameCarnageReport(HttpClient client, String activityId) Future<DestinyPostGameCarnageReportDataResponse>
Gets the available post game carnage report for the activity ID.
getProfile(HttpClient client, List<DestinyComponentType> components, String destinyMembershipId, BungieMembershipType membershipType) Future<DestinyProfileResponseResponse>
Returns Destiny Profile information for the supplied membership.
getPublicMilestoneContent(HttpClient client, int milestoneHash) Future<DestinyMilestoneContentResponse>
Gets custom localized content for the milestone of the given hash, if it exists.
getPublicMilestones(HttpClient client) Future<DictionaryOfuint32AndDestinyPublicMilestoneResponse>
Gets public information about currently available Milestones.
getPublicVendors(HttpClient client, List<DestinyComponentType> components) Future<DestinyPublicVendorsResponseResponse>
Get items available from vendors where the vendors have items for sale that are common for everyone. If any portion of the Vendor's available inventory is character or account specific, we will be unable to return their data from this endpoint due to the way that available inventory is computed. As I am often guilty of saying: 'It's a long story...'
getUniqueWeaponHistory(HttpClient client, String characterId, String destinyMembershipId, BungieMembershipType membershipType) Future<DestinyHistoricalWeaponStatsDataResponse>
Gets details about unique weapon usage, including all exotic weapons.
getVendor(HttpClient client, String characterId, List<DestinyComponentType> components, String destinyMembershipId, BungieMembershipType membershipType, int vendorHash) Future<DestinyVendorResponseResponse>
Get the details of a specific Vendor.
getVendors(HttpClient client, String characterId, List<DestinyComponentType> components, String destinyMembershipId, DestinyVendorFilter filter, BungieMembershipType membershipType) Future<DestinyVendorsResponseResponse>
Get currently available vendors from the list of vendors that can possibly have rotating inventory. Note that this does not include things like preview vendors and vendors-as-kiosks, neither of whom have rotating/dynamic inventories. Use their definitions as-is for those.
insertSocketPlug(HttpClient client, DestinyInsertPlugsActionRequest body) Future<DestinyItemChangeResponseResponse>
Insert a plug into a socketed item. I know how it sounds, but I assure you it's much more G-rated than you might be guessing. We haven't decided yet whether this will be able to insert plugs that have side effects, but if we do it will require special scope permission for an application attempting to do so. You must have a valid Destiny Account, and either be in a social space, in orbit, or offline. Request must include proof of permission for 'InsertPlugs' from the account owner.
insertSocketPlugFree(HttpClient client, DestinyInsertPlugsFreeActionRequest body) Future<DestinyItemChangeResponseResponse>
Insert a 'free' plug into an item's socket. This does not require 'Advanced Write Action' authorization and is available to 3rd-party apps, but will only work on 'free and reversible' socket actions (Perks, Armor Mods, Shaders, Ornaments, etc.). You must have a valid Destiny Account, and the character must either be in a social space, in orbit, or offline.
pullFromPostmaster(HttpClient client, DestinyPostmasterTransferRequest body) Future<Int32Response>
Extract an item from the Postmaster, with whatever implications that may entail. You must have a valid Destiny account. You must also pass BOTH a reference AND an instance ID if it's an instanced item.
reportOffensivePostGameCarnageReportPlayer(HttpClient client, String activityId, DestinyReportOffensePgcrRequest body) Future<Int32Response>
Report a player that you met in an activity that was engaging in ToS-violating activities. Both you and the offending player must have played in the activityId passed in. Please use this judiciously and only when you have strong suspicions of violation, pretty please.
searchDestinyEntities(HttpClient client, int page, String searchTerm, String type) Future<DestinyEntitySearchResultResponse>
Gets a page list of Destiny items.
searchDestinyPlayerByBungieName(HttpClient client, BungieMembershipType membershipType, ExactSearchRequest body) Future<IEnumerableOfUserInfoCardResponse>
Returns a list of Destiny memberships given a global Bungie Display Name. This method will hide overridden memberships due to cross save.
setItemLockState(HttpClient client, DestinyItemStateRequest body) Future<Int32Response>
Set the Lock State for an instanced item. You must have a valid Destiny Account.
setQuestTrackedState(HttpClient client, DestinyItemStateRequest body) Future<Int32Response>
Set the Tracking State for an instanced item, if that item is a Quest or Bounty. You must have a valid Destiny Account. Yeah, it's an item.
snapshotLoadout(HttpClient client, DestinyLoadoutUpdateActionRequest body) Future<Int32Response>
Snapshot a loadout with the currently equipped items.
transferItem(HttpClient client, DestinyItemTransferRequest body) Future<Int32Response>
Transfer an item to/from your vault. You must have a valid Destiny account. You must also pass BOTH a reference AND an instance ID if it's an instanced item. itshappening.gif
updateLoadoutIdentifiers(HttpClient client, DestinyLoadoutUpdateActionRequest body) Future<Int32Response>
Update the color, icon, and name of a loadout.