penicillin/blue.starry.penicillin.extensions.models

Package blue.starry.penicillin.extensions.models

Types

ProfileBannerSize

enum ProfileBannerSize : Enum<ProfileBannerSize>

Profile banners allow users to further customize the expressiveness of their profiles. To upload a profile banner on behalf of a user, use POST account / update_profile_banner. Profile banners come in a variety of display-enhanced sizes. The variant sizes are available through a request to GET users / profile_banner or by modifying the final path component of the profile_banner_url found in a user object according to the table below. The profile banner data available at each size variant’s URL is in PNG format.

ProfileImageSize

enum ProfileImageSize : Enum<ProfileImageSize>

Profile images (also known as avatars) are an important component of a Twitter account’s expression of identity. To upload a profile image on behalf of a user, use POST account / update_profile_image.

Functions

fun CommonUser.addToList(listId: Long): EmptyApiAction

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

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

Creates an action to add this user to the list.

fun CommonUser.block(): JsonObjectApiAction<User>

Creates an action to block this user.

fun Status.delete(): JsonObjectApiAction<Status>

Creates an action to delete this status.

fun Status.favorite(): JsonObjectApiAction<Status>

Creates an action to favorite this status.

fun CommonUser.follow(): JsonObjectApiAction<User>

Creates an action to follow this user.

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

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

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

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

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

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

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

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

fun Status.mention(text: String): JsonObjectApiAction<Status>

Creates an action to send a mention to this status.

suspend operator fun TwitterList.minusAssign(user: User)

Removes the user from this list. This function is suspend-function.

suspend operator fun TwitterList.minusAssign(users: Iterable<User>)

Removes the users from this list. This function is suspend-function.

fun CommonUser.mute(): JsonObjectApiAction<User>

Creates an action to mute this user.

suspend operator fun TwitterList.plusAssign(user: User)

Adds the user to this list. This function is suspend-function.

suspend operator fun TwitterList.plusAssign(users: Iterable<User>)

Adds the users to this list. This function is suspend-function.

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.

fun CommonUser.refresh(): JsonObjectApiAction<User>

Creates an action to retrieve this user.

fun Status.refresh(): JsonObjectApiAction<Status>

Creates an action to retrieve this status.

fun CommonUser.removeFromList(listId: Long): EmptyApiAction

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

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

Creates an action to remove this user from the list.

fun CommonUser.reportAsSpam(): JsonObjectApiAction<User>

Creates an action to report this user as spam.

fun Status.showCard(name: String): JsonObjectApiAction<CardState>

Creates new action to show card with name.

fun CommonUser.timeline(): JsonArrayApiAction<Status>

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

fun CommonUser.unblock(): JsonObjectApiAction<User>

Creates an action to unblock this user.

fun Status.unfavorite(): JsonObjectApiAction<Status>

Creates an action to unfavorite this status.

fun CommonUser.unfollow(): JsonObjectApiAction<User>

Creates an action to unfollow this user.

fun CommonUser.unmute(): JsonObjectApiAction<User>

Creates an action to unmute this user.

Properties

val CardState.Card.choices: LinkedHashMap<String, Int>

A map of choices. Map size N must be 2 <= N <= 4.

val CardState.Card.endAt: String?

Card end at date.

val DirectMessageEvent.List.Event.MessageCreate.MessageData.expandedText: String

Returns the direct message text whose shortened urls are each expanded.

val Status.expandedText: String

Returns full-body status text which shortened urls in are each expanded.

expandedTextWithIndices

~~val~~ Status.~~expandedTextWithIndices~~: String

Returns full-body status text which shortened urls in are each expanded.

val IndexedEntityModel.firstIndex: Int

Returns the first index of the indices.

val Status.hasCard: Boolean

If true, this status has card entity.

val CardState.Card.isFinalResult: Boolean

If true, this card is final result.

isLockedAccount

val CommonUser.isLockedAccount: Boolean

Whether if this account is locked.

val IndexedEntityModel.lastIndex: Int

Returns the last index of this indices.

val CardState.Card.lastUpdateAt: String?

Card last update at date.

val CardState.Card.minutes: Int?

Card duration in minutes.

val IndexedEntityModel.range: IntRange

Returns a range from firstIndex value up to but excluding lastIndex value.

val IndexedEntityModel.size: Int

Returns the size of the indices.

val Status.text: String

Returns full-body, unescaped status text. Supports both tweet modes (Extend and Compat).