Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface 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.

Hierarchy

  • UserInfoCard

Index

Properties

displayName

displayName: 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.

iconPath

iconPath: string

URL the Icon if available.

membershipId

membershipId: string

Membership ID as they user is known in the Accounts service

membershipType

membershipType: BungieMembershipType

Type of the membership.

supplementalDisplayName

supplementalDisplayName: string

A platform specific additional display name - ex: psn Real Name, bnet Unique Name, etc.