penicillin/blue.starry.penicillin.core.session.config

Package blue.starry.penicillin.core.session.config

Types

data class ApiConfig( val emulationMode: EmulationMode, val skipEmulationChecking: Boolean, val defaultTweetMode: TweetMode) : SessionConfig

Configurations related to api execution.

Credentials

data class Credentials( val consumerKey: String?, val consumerSecret: String?, val accessToken: String?, val accessTokenSecret: String?, val bearerToken: String?, val knownDeviceToken: String?) : SessionConfig

Represents your application and account credentials.

SessionConfig

interface SessionConfig

Represents additional config from SessionConfigBuilder.

SessionConfigBuilder

interface SessionConfigBuilder<C : SessionConfig>

Represents additional config builder which is used in ApiClient builder.

Functions

account

fun SessionBuilder.account(block: Credentials.Builder.() -> Unit)

Initializes account configuration.

api

fun SessionBuilder.api(block: ApiConfig.Builder.() -> Unit)

Creates ApiConfig configurations. Provides timeout, retries, emulations and so on.

application

fun Credentials.Builder.application(client: OfficialClient.OAuth1a)

Configures your application with predefined OAuth 1.0a client.

fun Credentials.Builder.application(consumerKey: String, consumerSecret: String)

Configures your application with consumer key and consumer secret.

httpClient

fun SessionBuilder.httpClient(client: HttpClient)

Creates HttpClient with existing client.

fun SessionBuilder.httpClient(block: HttpClientConfig<*>.() -> Unit = {})

Creates HttpClient with default engine factory and engine config block

fun <T : HttpClientEngineConfig> SessionBuilder.httpClient(engineFactory: HttpClientEngineFactory<T>, block: HttpClientConfig<T>.() -> Unit = {})

Creates HttpClient with engine factory and config block.

skipEmulationChecking

fun ApiConfig.Builder.skipEmulationChecking()

Skips emulationMode checking.

token

fun Credentials.Builder.token(client: OfficialClient.OAuth2)

Configures your account with predefined OAuth 2 client.

fun Credentials.Builder.token(bearerToken: String)

Configures your account with bearer token.

fun Credentials.Builder.token(accessToken: String, accessTokenSecret: String)

Configures your account with access token and access token secret.