Module org.mastodon4j.core

Package org.mastodon4j.core.api

Interface BaseMastodonApi

All Known Subinterfaces:

MastodonApi

All Known Implementing Classes:

MastodonClient

public interface BaseMastodonApi

Contains all global related REST call methods.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	BaseMastodonApi.QueryOptions

Method Summary

Modifier and Type	Method	Description
Instance	instance()	View server information
Search	search(BaseMastodonApi.QueryOptions queryOptions)	Perform a search

Method Details

instance

Instance instance()

View server information

Obtain general information about the server.

Returns:

a instance information object

search

Search search(BaseMastodonApi.QueryOptions queryOptions)

Perform a search

Parameters:

queryOptions - query options record containing all query parameters

Returns:

a search result instance