User

@Serializable
data class User(val id: String, val login: String, val displayName: String, val type: String = "", val broadcasterType: String = "", val description: String = "", val profileImageUrl: String = "", val offlineImageUrl: String = "", val viewCount: Int = 0, val email: String? = null, val createdAt: Instant? = null)

Represents a Twitch user from the Helix API.

See also

Constructors

Link copied to clipboard
constructor(id: String, login: String, displayName: String, type: String = "", broadcasterType: String = "", description: String = "", profileImageUrl: String = "", offlineImageUrl: String = "", viewCount: Int = 0, email: String? = null, createdAt: Instant? = null)

Properties

Link copied to clipboard
@SerialName(value = "broadcaster_type")
val broadcasterType: String

the type of broadcaster. Possible values are: affiliate, partner, "" (normal broadcaster).

Link copied to clipboard
@SerialName(value = "created_at")
val createdAt: Instant?

the UTC date and time that the user's account was created. The timestamp is in RFC3339 format.

Link copied to clipboard

the user's description of their channel.

Link copied to clipboard
@SerialName(value = "display_name")
val displayName: String

the user's display name.

Link copied to clipboard

the user's verified email address. The object includes this field only if the user access token includes the user:read:email scope.

Link copied to clipboard
val id: String

an ID that identifies the user.

Link copied to clipboard

the user's login name.

Link copied to clipboard
@SerialName(value = "offline_image_url")
val offlineImageUrl: String

a URL to the user's offline image.

Link copied to clipboard
@SerialName(value = "profile_image_url")
val profileImageUrl: String

a URL to the user's profile image.

Link copied to clipboard

the type of user. Possible values are: admin, global_mod, staff, "" (normal user).

Link copied to clipboard
@SerialName(value = "view_count")
val viewCount: Int

DEPRECATED The number of times the user's channel has been viewed. Any data in this field is not valid and should not be used.