mastodonk-core/fr.outadoc.mastodonk.api.endpoint.accounts/AccountsApi

AccountsApi

interface AccountsApi

Methods concerning user accounts and related information.

See also

Functions

Link copied to clipboard
abstract suspend fun blockAccount(accountId: String): Relationship

Blocks the given account.

Link copied to clipboard
abstract suspend fun commentOnAccount(accountId: String, comment: String? = null): Relationship

Sets a private note on a user.

Link copied to clipboard
abstract suspend fun featureAccount(accountId: String): Relationship

Adds the given account to the user's featured profiles.

Link copied to clipboard
abstract suspend fun followAccount(accountId: String, reblogs: Boolean? = null, notify: Boolean? = null): Relationship

Follows the given account.

Link copied to clipboard
abstract suspend fun getAccount(accountId: String): Account?

Gets information about a profile.

Link copied to clipboard
abstract suspend fun getFeaturedTags(accountId: String): List<FeaturedTag>?

Gets tags featured by this account.

Link copied to clipboard
abstract suspend fun getFollowers(accountId: String, limit: Int? = null, pageInfo: PageInfo? = null): Page<List<Account>>?

Gets the list of accounts which follow the given account, if network is not hidden by the account owner.

Link copied to clipboard
abstract suspend fun getFollowing(accountId: String, limit: Int? = null, pageInfo: PageInfo? = null): Page<List<Account>>?

Gets the list of accounts which the given account is following, if network is not hidden by the account owner.

Link copied to clipboard
abstract suspend fun getIdentityProofs(accountId: String): List<IdentityProof>?

Gets identity proofs for this account.

Link copied to clipboard
abstract suspend fun getListsContainedIn(accountId: String): List<UserList>?

Gets the user lists that you have added this account to.

Link copied to clipboard
abstract suspend fun getRelationships(accountIds: List<String>): List<Relationship>?

Gets the relationship between the current account and the given accounts.

Link copied to clipboard
abstract suspend fun getStatuses(accountId: String, limit: Int? = null, pageInfo: PageInfo? = null): Page<List<Status>>?

Gets statuses posted by the given account.

Link copied to clipboard
abstract suspend fun muteAccount(accountId: String): Relationship

Mutes the given account.

Link copied to clipboard
abstract suspend fun register(account: AccountCreate): Token

Creates a user and account records.

Link copied to clipboard
abstract suspend fun search(query: String, limit: Int? = null, resolve: Boolean? = null, following: Boolean? = null): List<Account>

Searches for matching accounts by username or display name.

Link copied to clipboard
abstract suspend fun unblockAccount(accountId: String): Relationship

Unblocks the given account.

Link copied to clipboard
abstract suspend fun unfeatureAccount(accountId: String): Relationship

Removes the given account from the user's featured profiles.

Link copied to clipboard
abstract suspend fun unfollowAccount(accountId: String): Relationship

Unfollows the given account.

Link copied to clipboard
abstract suspend fun unmuteAccount(accountId: String): Relationship

Unmutes the given account.

Link copied to clipboard
abstract suspend fun updateCredentials(displayName: String? = null, note: String? = null, avatar: File? = null, header: File? = null, isBot: Boolean? = null, isDiscoverable: Boolean? = null, isLocked: Boolean? = null, isSensitive: Boolean? = null, privacy: StatusVisibility? = null, language: String? = null, fields: List<Field>? = null): Account

Updates the user's display and preferences.

Link copied to clipboard
abstract suspend fun verifyCredentials(): Account

Verifies that the user token works.