Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

client

client: Client

The client that instantiated this class

country

country: null | string

The country of the user, as set in the user’s account profile. An ISO 3166-1 alpha-2 country code. This field is only available when the current user has granted access to the user-read-private scope

displayName

displayName: null | string

The name displayed on the user’s profile

email

email: null | string

The user’s email address, as entered by the user when creating their account. This field is only available when the current user has granted access to the user-read-email scope.

⚠️Important: This email address is unverified, there is no proof that it actually belongs to the user

explicitContent

explicitContent: null | ExplicitContentSettings

The user’s explicit content settings. This field is only available when the current user has granted access to the user-read-private scope.

externalUrls

externalUrls: ExternalUrl

Known public external URLs for this user

followers

followers: null | Followers

Information about the followers of this user

href

href: string

A link to the Web API endpoint for this user

id

id: string

The Spotify ID of the structure

images

images: null | Image[]

The user’s profile image

product

product: string

The user’s Spotify subscription level: premium, free, etc. This field is only available when the current user has granted access to the user-read-private scope.

⚠️Note: The subscription level open can be considered the same as free

rawObjectType

rawObjectType: string

The raw object type returned by the api: user

uri

uri: string

The Spotify URI for this user

Legend

  • Constructor
  • Property
  • Method
  • Constructor
  • Property
  • Inherited property
  • Inherited method
  • Protected property
  • Protected method
  • Private property
  • Private method

Generated using TypeDoc