SpotifyUserInformation

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

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.UserReadPrivate scope.

displayName

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

email

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.UserReadEmail scope.

followers

Information about the followers of the user.

href

A link to the Web API endpoint for this user.

id

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.UserReadPrivate scope.

type

The object type: “user”

Constructors

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

Properties

Link copied to clipboard
@Transient
lateinit var api: GenericSpotifyApi

The API client associated with the request

Link copied to clipboard
val country: String? = null
Link copied to clipboard
@SerialName(value = "display_name")
val displayName: String? = null
Link copied to clipboard
val email: String? = null
Link copied to clipboard
@SerialName(value = "explicit_content")
val explicitContentSettings: ExplicitContentSettings? = null
Link copied to clipboard

Known external URLs for this object

Link copied to clipboard
Link copied to clipboard
open override val href: String
Link copied to clipboard
open override val id: String
Link copied to clipboard
val images: List<SpotifyImage>? = null
Link copied to clipboard
val product: String? = null
Link copied to clipboard
Link copied to clipboard
open override val uri: UserUri

The URI associated with the object

Functions