penicillin/blue.starry.penicillin.models/CommonUser

CommonUser

abstract class CommonUser(val json: JsonObject, val client: ApiClient) : PenicillinModel

Constructors

CommonUser

fun CommonUser(json: JsonObject, client: ApiClient)

Types

ProfileImageExtension

data class ProfileImageExtension(val json: JsonObject, val client: ApiClient) : PenicillinModel

Functions

equals

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

Indicates whether some other model is "equal to" this one.

hashCode

open override fun hashCode(): Int

Returns a hash code value for the model.

toString

abstract override fun toString(): String

Returns a string representation of the model.

Properties

advertiserAccountServiceLevels

val advertiserAccountServiceLevels: List<String>

advertiserAccountType

val advertiserAccountType: String?

analyticsType

val analyticsType: String?

blockedBy

val blockedBy: Boolean

blocking

val blocking: Boolean

businessProfileState

val businessProfileState: String?

canMediaTag

val canMediaTag: Boolean?

client

override val client: ApiClient

The ApiClient instance.

contributorsEnabled

val contributorsEnabled: Boolean

createdAtRaw

val createdAtRaw: String

defaultProfile

val defaultProfile: Boolean

defaultProfileImage

val defaultProfileImage: Boolean

description

val description: String

entities

val entities: UserEntity?

fastFollowersCount

val fastFollowersCount: Int?

favouritesCount

val favouritesCount: Int

followedBy

val followedBy: Boolean?

followersCount

val followersCount: Int

following

val following: Boolean

followRequestSent

val followRequestSent: Boolean

friendsCount

val friendsCount: Int

geoEnabled

val geoEnabled: Boolean

hasCustomTimelines

val hasCustomTimelines: Boolean?

hasExtendedProfile

val hasExtendedProfile: Boolean

val id: Long

idStr

val idStr: String

isTranslationEnabled

val isTranslationEnabled: Boolean

isTranslator

val isTranslator: Boolean

json

override val json: JsonObject

The underlying JsonObject.

keyCase

open val keyCase: JsonKeyCase

keyConverter

open val keyConverter: JsonKeyConverter

langRaw

val langRaw: String?

listedCount

val listedCount: Int

liveFollowing

val liveFollowing: Boolean

val location: String

val mediaCount: Int?

val muting: Boolean

val name: String

needsPhoneVerification

val needsPhoneVerification: Boolean?

normalFollowersCount

val normalFollowersCount: Int?

notifications

val notifications: Boolean

pinnedTweetIds

val pinnedTweetIds: List<Long>

pinnedTweetIdsStr

val pinnedTweetIdsStr: List<String>

profileBackgroundColor

val profileBackgroundColor: String

profileBackgroundImageUrl

val profileBackgroundImageUrl: String?

profileBackgroundImageUrlHttps

val profileBackgroundImageUrlHttps: String?

profileBackgroundTile

val profileBackgroundTile: Boolean

profileBannerExtension

val profileBannerExtension: CommonUser.ProfileImageExtension?

profileBannerUrl

val profileBannerUrl: String?

profileImageExtensions

val profileImageExtensions: CommonUser.ProfileImageExtension?

profileImageUrl

val profileImageUrl: String

profileImageUrlHttps

val profileImageUrlHttps: String

profileInterstitialType

val profileInterstitialType: String?

profileLinkColor

val profileLinkColor: String

profileLocation

val profileLocation: JsonElement?

profileSidebarBorderColor

val profileSidebarBorderColor: String

profileSidebarFillColor

val profileSidebarFillColor: String

profileTextColor

val profileTextColor: String

profileUseBackgroundImage

val profileUseBackgroundImage: Boolean

protected

val protected: Boolean

screenName

val screenName: String

status

val status: Status?

statusesCount

val statusesCount: Int

suspended

val suspended: Boolean?

timeZone

val timeZone: String

translatorType

val translatorType: String

url

val url: String?

utcOffset

val utcOffset: Int

verified

val verified: Boolean

withheldInCountries

val withheldInCountries: List<String>

withheldScope

val withheldScope: String?

Inheritors

VerifyCredentials

User

Extensions

addToList

fun CommonUser.addToList(listId: Long): EmptyApiAction

fun CommonUser.addToList(slug: String, ownerScreenName: String): EmptyApiAction

fun CommonUser.addToList(slug: String, ownerId: Long): EmptyApiAction

Creates an action to add this user to the list.

block

fun CommonUser.block(): JsonObjectApiAction<User>

Creates an action to block this user.

createdAt

val CommonUser.createdAt: CreatedAt

Parsed "created_at" object.

fun CommonUser.follow(): JsonObjectApiAction<User>

Creates an action to follow this user.

followerIds

fun CommonUser.followerIds(): CursorJsonObjectApiAction<CursorIds, Long>

Creates an action to retrieve followers' ids of this user.

followerUsers

fun CommonUser.followerUsers(): CursorJsonObjectApiAction<CursorUsers, User>

Creates an action to retrieve followers' users of this user.

friendIds

fun CommonUser.friendIds(): CursorJsonObjectApiAction<CursorIds, Long>

Creates an action to retrieve friends' (follows') ids of this user.

friendUsers

fun CommonUser.friendUsers(): CursorJsonObjectApiAction<CursorUsers, User>

Creates an action to retrieve friends' (follows') users of this user.

isLockedAccount

val CommonUser.isLockedAccount: Boolean

Whether if this account is locked.

lang

~~val~~ CommonUser.~~lang~~: Language?

Parsed "lang" object.

mute

fun CommonUser.mute(): JsonObjectApiAction<User>

Creates an action to mute this user.

profileBannerUrlWithVariantSize

fun CommonUser.profileBannerUrlWithVariantSize(size: ProfileBannerSize): String?

Returns profile banner url with specified size.

profileImageUrlHttpsWithVariantSize

fun CommonUser.profileImageUrlHttpsWithVariantSize(size: ProfileImageSize): String

Returns profile image url (HTTPS) with specified size.

profileImageUrlWithVariantSize

fun CommonUser.profileImageUrlWithVariantSize(size: ProfileImageSize): String

Returns profile image url with specified size.

refresh

fun CommonUser.refresh(): JsonObjectApiAction<User>

Creates an action to retrieve this user.

removeFromList

fun CommonUser.removeFromList(listId: Long): EmptyApiAction

fun CommonUser.removeFromList(slug: String, ownerScreenName: String): EmptyApiAction

fun CommonUser.removeFromList(slug: String, ownerId: Long): EmptyApiAction

Creates an action to remove this user from the list.

reportAsSpam

fun CommonUser.reportAsSpam(): JsonObjectApiAction<User>

Creates an action to report this user as spam.

timeline

fun CommonUser.timeline(): JsonArrayApiAction<Status>

Creates an ation to retrieve the user timeline of this user.

unblock

fun CommonUser.unblock(): JsonObjectApiAction<User>

Creates an action to unblock this user.

unfollow

fun CommonUser.unfollow(): JsonObjectApiAction<User>

Creates an action to unfollow this user.

unmute

fun CommonUser.unmute(): JsonObjectApiAction<User>

Creates an action to unmute this user.