user library

Classes

BungieMembershipType
DateRange
GeneralUser
GetBungieNetUserByIdParams
GetMembershipDataByIdParams
GetPartnershipsParams
HttpClient
A generic, minimal type for providing an HTTP client function. This gets the necessary config provided as an argument, and then should produce a promise for the parsed JSON as a result. The API helper functions will use this to return the right type.
HttpClientConfig
HyperlinkReference
IgnoreResponse
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. [...]
IgnoreStatus
InterpolationPoint
InterpolationPointFloat
PagedQuery
PartnershipType
PlatformErrorCodes
PublicPartnershipDetail
All the partnership info that's fit to expose externally, if we care to do so.
SearchUsersParams
ServerResponse<T>
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. [...]
TagResponse
UserInfoCard
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.
UserMembership
Very basic info about a user as returned by the Account server.
UserMembershipData
UserTheme
UserToUserContext

Functions

getAvailableThemes(HttpClient http) → Future<ServerResponse<List<UserTheme>>>
Returns a list of all available user themes.
getBungieNetUserById(HttpClient http, GetBungieNetUserByIdParams params) → Future<ServerResponse<GeneralUser>>
Loads a bungienet user by membership id.
getMembershipDataById(HttpClient http, GetMembershipDataByIdParams params) → Future<ServerResponse<UserMembershipData>>
Returns a list of accounts associated with the supplied membership ID and membership type. This will include all linked accounts (even when hidden) if supplied credentials permit it.
getMembershipDataForCurrentUser(HttpClient http) → Future<ServerResponse<UserMembershipData>>
Returns a list of accounts associated with signed in user. This is useful for OAuth implementations that do not give you access to the token response.
getPartnerships(HttpClient http, GetPartnershipsParams params) → Future<ServerResponse<List<PublicPartnershipDetail>>>
Returns a user's linked Partnerships.
searchUsers(HttpClient http, SearchUsersParams params) → Future<ServerResponse<List<GeneralUser>>>
Returns a list of possible users based on the search string