helix/io.github.captnblubber.twitchkt.helix.model/User

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

Twitch API Reference - Get Users

Constructors

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

broadcasterType

@SerialName(value = "broadcaster_type")

val broadcasterType: String

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

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

val description: String

the user's description of their channel.

@SerialName(value = "display_name")

val displayName: String

the user's display name.

val email: String?

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

an ID that identifies the user.

val login: String

the user's login name.

offlineImageUrl

@SerialName(value = "offline_image_url")

val offlineImageUrl: String

a URL to the user's offline image.

profileImageUrl

@SerialName(value = "profile_image_url")

val profileImageUrl: String

a URL to the user's profile image.

val type: String

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

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