penicillin/blue.starry.penicillin.endpoints/Help

Help

class Help(val client: ApiClient) : Endpoint

Collection of api endpoints related to developer utilities.

See also

Parameters

client

Current ApiClient instance.

Constructors

fun Help(client: ApiClient)

Creates new Help endpoint instance.

Properties

open override val client: ApiClient

Extensions

val Help.configuration: JsonObjectApiAction<Help.Configuration>

Shorthand property to Help.configuration.

fun Help.configuration(vararg options: Option): JsonObjectApiAction<Help.Configuration>

Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co shortened URL length. It is recommended applications request this endpoint when they are loaded, but no more than once a day.

val Help.languages: JsonArrayApiAction<Help.Language>

Shorthand property to Help.languages.

fun Help.languages(vararg options: Option): JsonArrayApiAction<Help.Language>

Returns the list of languages supported by Twitter along with the language code supported by Twitter. The language code may be formatted as ISO 639-1 alpha-2 (en), ISO 639-3 alpha-3 (msa), or ISO 639-1 alpha-2 combined with an ISO 3166-1 alpha-2 localization (zh-tw).

val Help.privacy: JsonObjectApiAction<Help.Privacy>

Shorthand property to Help.privacy.

fun Help.privacy(vararg options: Option): JsonObjectApiAction<Help.Privacy>

Returns Twitter's Privacy Policy.

val Help.settings: JsonObjectApiAction<Help.Settings>

Shorthand property to Help.settings.

fun Help.settings( includeZeroRate: Boolean? = null, settingsVersion: String? = null, vararg options: Option): JsonObjectApiAction<Help.Settings>

Unknown endpoint.

val Help.tos: JsonObjectApiAction<Help.Tos>

Shorthand property to Help.tos.

fun Help.tos(vararg options: Option): JsonObjectApiAction<Help.Tos>

Returns the Twitter Terms of Service. Note: these are not the same as the Developer Policy.