SpotifyUserInformation

data class SpotifyUserInformation(externalUrlsString: Map<String, String>, href: String, id: String, uri: UserUri, country: String?, displayName: String?, email: String?, followers: Followers, images: List<SpotifyImage>, product: String?, explicitContentSettings: ExplicitContentSettings?, type: String) : CoreObject

Private information about a Spotify user. Each field may require a specific scope.

Parameters

country

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 SpotifyScope.USER_READ_PRIVATE scope.

displayName

The name displayed on the user’s profile. null if not available.

The user’s email address, as entered by the user when creating their account. Important! This email address is unverified; there is no proof that it actually belongs to the user. This field is only available when the current user has granted access to the SpotifyScope.USER_READ_EMAIL scope.

followers

Information about the followers of the user.

href

A link to the Web API endpoint for this user.

The Spotify user ID for the user

images

The user’s profile image.

product

The user’s Spotify subscription level: “premium”, “free”, etc. (The subscription level “open” can be considered the same as “free”.) This field is only available when the current user has granted access to the SpotifyScope.USER_READ_PRIVATE scope.

type

The object type: “user”

Constructors

SpotifyUserInformation

common

fun SpotifyUserInformation(externalUrlsString: Map<String, String>, href: String, id: String, uri: UserUri, country: String? = null, displayName: String? = null, email: String? = null, followers: Followers, images: List<SpotifyImage>, product: String? = null, explicitContentSettings: ExplicitContentSettings? = null, type: String)

The country of the user, as set in the user’s account profile.

Functions

component10

common

operator fun component10(): String?

component11

common

operator fun component11(): ExplicitContentSettings?

component12

common

operator fun component12(): String

component2

common

operator fun component2(): String

component3

common

operator fun component3(): String

component4

common

operator fun component4(): UserUri

component5

common

operator fun component5(): String?

component6

common

operator fun component6(): String?

component7

common

operator fun component7(): String?

component8

common

operator fun component8(): Followers

component9

common

operator fun component9(): List<SpotifyImage>

copy

common

fun copy(externalUrlsString: Map<String, String>, href: String, id: String, uri: UserUri, country: String? = null, displayName: String? = null, email: String? = null, followers: Followers, images: List<SpotifyImage>, product: String? = null, explicitContentSettings: ExplicitContentSettings? = null, type: String): SpotifyUserInformation

equals

common

open operator override fun equals(other: Any?): Boolean

getMembersThatNeedApiInstantiation

common

open override fun getMembersThatNeedApiInstantiation(): List<NeedsApi?>

hashCode

common

open override fun hashCode(): Int

toString

common

open override fun toString(): String

Properties

api

common

lateinit var api: GenericSpotifyApi

The API client associated with the request

country

common

val country: String? = null

The country of the user, as set in the user’s account profile.

displayName

common

val displayName: String? = null

The name displayed on the user’s profile.

common

val email: String? = null

The user’s email address, as entered by the user when creating their account.

explicitContentSettings

common

val explicitContentSettings: ExplicitContentSettings? = null

externalUrls

common

val externalUrls: List<ExternalUrl>

Known external URLs for this object

followers

common

val followers: Followers

Information about the followers of the user.

href

common

open override val href: String

A link to the Web API endpoint for this user.

common

open override val id: String

The Spotify user ID for the user

images

common

val images: List<SpotifyImage>

The user’s profile image.

product

common

val product: String? = null

The user’s Spotify subscription level: “premium”, “free”, etc.

type

common

val type: String

The object type: “user”

uri

common

open override val uri: UserUri

The URI associated with the object

Sources

(source)