mastodonk-core/fr.outadoc.mastodonk.api.entity.request

Package-level declarations

Objects used for sending API requests.

Types

@Serializable

data class AccountAction(val type: ActionType? = null, val reportId: String? = null, val warningPresetId: String? = null, val reason: String?, val sendEmailNotification: Boolean? = null)

Object to perform an action against an Account.

AccountCreate

@Serializable

data class AccountCreate(val username: String, val email: String, val password: String, val agreement: String, val locale: String, val reason: String? = null)

Object to create a new Account.

ApplicationCreate

@Serializable

data class ApplicationCreate(val clientName: String, val redirectUris: String, val scopes: String?, val website: String?)

Object to register a new Application.

File

data class File(val contents: ByteReadChannel, val filename: String, val contentType: String)

A file to be uploaded to a Mastodon API.

FilterCreate

@Serializable

data class FilterCreate(val phrase: String, val context: List<FilterContext>, val isIrreversible: Boolean?, val wholeWord: Boolean?, val expiresInSec: Long?)

Object used to create a new Filter.

FilterUpdate

@Serializable

data class FilterUpdate(val phrase: String, val context: List<FilterContext>, val isIrreversible: Boolean?, val wholeWord: Boolean?, val expiresInSec: Long?)

Object used to update an existing Filter.

MarkerCreate

@Serializable

data class MarkerCreate(val home: MarkerCreateProperties, val notifications: MarkerCreateProperties)

Object used to create a new Marker.

MarkerCreateProperties

@Serializable

data class MarkerCreateProperties(val lastReadId: String)

Object used to save the current position in a timeline.

PollCreate

@Serializable

data class PollCreate(val options: List<PollOption>, val expiresInSec: Long, val allowMultipleChoices: Boolean?, val hideTotals: Boolean?)

Object used to create a new Poll.

PushData

@Serializable

data class PushData(val alerts: Alerts)

Object used to set notification alert settings.

PushKeys

@Serializable

data class PushKeys(val p256dhBase64: String, val authBase64: String)

Push keys used for notifications.

PushSubscribe

@Serializable

data class PushSubscribe(val subscription: PushSubscription, val data: PushData)

Object used to subscribe to push notifications.

PushSubscription

@Serializable

data class PushSubscription(val endpoint: String, val keys: PushKeys)

Push subscription

PushUpdate

@Serializable

data class PushUpdate(val data: PushData)

Object to update push alert settings.

ReportCreate

@Serializable

data class ReportCreate(val accountId: String, val statusIds: List<String>?, val comment: String?, val forwardToRemoteAdmin: Boolean?)

Object used to submit a new report.

ScheduledStatusCreate

@Serializable

data class ScheduledStatusCreate(val scheduledAt: Instant, val status: String? = null, val mediaIds: List<String>? = null, val poll: PollCreate? = null, val inReplyToId: String? = null, val isSensitive: Boolean? = null, val contentWarningText: String? = null, val visibility: StatusVisibility? = null, val language: String? = null)

Object used to schedule a status.

StatusCreate

@Serializable

data class StatusCreate(val status: String? = null, val mediaIds: List<String>? = null, val poll: PollCreate? = null, val inReplyToId: String? = null, val isSensitive: Boolean? = null, val contentWarningText: String? = null, val visibility: StatusVisibility? = null, val language: String? = null)

Object used to post a new Status.

TokenGet

@Serializable

data class TokenGet(val clientId: String, val clientSecret: String, val redirectUri: String, val grantType: GrantType, val scope: String?, val code: String?)

Object used to get a new Token.

TokenRevoke

@Serializable

data class TokenRevoke(val clientId: String, val clientSecret: String, val token: String)

Object used to revoke a Token.