penicillin/blue.starry.penicillin.extensions

Package blue.starry.penicillin.extensions

Types

AccessLevel

enum AccessLevel : Enum<AccessLevel>

Represents "x-access-level" header.

CreatedAt

data class CreatedAt(val value: String)

Represents "created_at" date format.

Language

data class Language(val value: String)

Represents parsed "lang" object.

RateLimit

data class RateLimit( val limit: Int, val remaining: Int, val resetAt: GMTDate)

Represents Twitter API rate limit.

StatusID

data class StatusID(val value: Long)

Represents numerical status id.

Via

data class Via( val url: String, val name: String, val attributes: Map<String, String>)

Represents tag in "source".

Functions

awaitRefresh

suspend fun RateLimit.awaitRefresh()

Awaits until rate limit is refreshed. (Suspending function)

blockUntilRefresh

fun RateLimit.blockUntilRefresh()

Blocks until rate limit is refreshed. (Classic blocking function)

DelegatedAction

fun <R> Endpoint.DelegatedAction(block: suspend () -> R): ApiAction<R>

Creates an ApiAction that is resolved with passed lambda block.

edit

fun <R : Any> ApiAction<R>.edit(block: ApiRequestBuilder.() -> Unit): ApiAction<R>

Modifies current ApiRequestBuilder with the block.

executeWithTimeout

suspend fun <R : Any> ApiAction<R>.executeWithTimeout(timeout: Duration): R?

Awaits api execution and returns its result with timeout. This function is suspend-function.

MediaComponent

fun MediaComponent( file: File, type: MediaType, category: MediaCategory = MediaCategory.TweetImage): MediaComponent

fun MediaComponent( path: Path, type: MediaType, category: MediaCategory = MediaCategory.TweetImage): MediaComponent

use

inline fun <C : Closeable, R> C.use(block: (C) -> R): R

Closes the receiver after block. Compatibility function.

Properties

accessLevels

val ApiResponse<*>.accessLevels: Set<AccessLevel>

Set of "x-access-level" header. If this header is absent or unknown, returns empty set.

consumed

val RateLimit.consumed: Int

The count you consumed in last 15 minutes.

createdAt

val ActivityEvent.createdAt: CreatedAt

Parsed "created_at" object.

val DirectMessage.createdAt: CreatedAt

Parsed "created_at" object.

val SavedSearch.createdAt: CreatedAt

Parsed "created_at" object.

val Status.createdAt: CreatedAt

Parsed "created_at" object.

val TwitterList.createdAt: CreatedAt

Parsed "created_at" object.

val CommonUser.createdAt: CreatedAt

Parsed "created_at" object.

val Stream.Event.createdAt: CreatedAt

Parsed "created_at" object.

duration

val RateLimit.duration: Duration

The Duration between now and RateLimit.resetAt.

hasDirectMessagesPermission

val ApiResponse<*>.hasDirectMessagesPermission: Boolean

Checks if this application has "direct messages" permission.

hasReadPermission

val ApiResponse<*>.hasReadPermission: Boolean

Checks if this application has "read" permission.

hasWritePermission

val ApiResponse<*>.hasWritePermission: Boolean

Checks if this application has "write" permission.

idObj

val Status.idObj: StatusID

Parsed status id object for "id".

inReplyToStatusIdObj

val Status.inReplyToStatusIdObj: StatusID?

Parsed status id object for "in_reply_to_status_id".

instant

val CreatedAt.instant: Instant

New Instant instance for this "created_at" string.

val StatusID.instant: Instant

New Instant instance with epoch time.

isExceeded

val RateLimit.isExceeded: Boolean

The flag indicates you may access the same endpoint more at this time. If true, rate limit exceeded.

lang

val Status.lang: Language

Parsed "lang" object.

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

Parsed "lang" object.

language

val Account.Settings.language: Language

Parsed "language" object.

lastPublishTime

val Moment.lastPublishTime: CreatedAt

Parsed "lastPublishTime" object.

likeCount

val Status.likeCount: Int

Compatibility extension to Status.favoriteCount.

liked

val Status.liked: Boolean

Compatibility extension to Status.favorited.

likesCount

val User.likesCount: Int

Compatibility extension to User.favouritesCount.

locale

val Language.locale: Locale

New Locale instance for this "lang" value.

quotedStatusIdObj

val Status.quotedStatusIdObj: StatusID?

Parsed status id object for "quoted_status_id.

rateLimit

val ApiResponse<*>.rateLimit: RateLimit?

Twitter API rate limit. If response header does not provide such information, returns null.

val PenicillinException.rateLimit: RateLimit?

Twitter API rate limit. If response header does not provide such information or response is null, returns null.

responseTimeMs

val ApiResponse<*>.responseTimeMs: Int?

"x-response-time" value from response header. if the header is absent or invalid, returns null.

session

val ApiRequestBuilder.session: Session

Shorthand extension to ApiClient.

val ApiRequest.session: Session

Shorthand extension to ApiClient.

val ApiAction<*>.session: Session

Shorthand extension to ApiClient.

val ApiResponse<*>.session: Session

Shorthand extension to ApiClient.

sourceStatusIdObj

val MediaEntity.sourceStatusIdObj: StatusID?

Parsed status id object for "source_status_id".

via

val Status.via: Via

Parsed status source.