Module org.mastodon4j.core

Package org.mastodon4j.core

Class MastodonClient

java.lang.Object

org.mastodon4j.core.MastodonClient

All Implemented Interfaces:

BaseMastodonApi, MastodonApi

public class MastodonClient
extends Object
implements MastodonApi

Nested Class Summary

Nested classes/interfaces inherited from interface org.mastodon4j.core.api.BaseMastodonApi

BaseMastodonApi.QueryOptions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	USER_AGENT_NAME

Method Summary

Modifier and Type	Method	Description
Accounts	accounts()
Apps	apps()
static MastodonApi	create(String restUrl, AccessToken accessToken)	Creates an mastodon API instance for the given restUrl and access token.
Instance	instance()	View server information
Lists	lists()
Notifications	notifications()
Search	search(String query)	Search for content in accounts, statuses and hashtags.
Search	search(BaseMastodonApi.QueryOptions queryOptions)	Perform a search
Statuses	statuses()
Streaming	streaming()
Timelines	timelines()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

USER_AGENT_NAME

public static final String USER_AGENT_NAME

See Also:

• Constant Field Values

Method Details

create

public static MastodonApi create(String restUrl,
 AccessToken accessToken)

Creates an mastodon API instance for the given restUrl and access token.

Parameters:

restUrl - the base URL of a mastodon server

accessToken - the access token for the given instance

Returns:

a new API ineraction instance

accounts

public Accounts accounts()

Specified by:

accounts in interface MastodonApi

apps

public Apps apps()

Specified by:

apps in interface MastodonApi

lists

public Lists lists()

Specified by:

lists in interface MastodonApi

notifications

public Notifications notifications()

Specified by:

notifications in interface MastodonApi

statuses

public Statuses statuses()

Specified by:

statuses in interface MastodonApi

streaming

public Streaming streaming()

Specified by:

streaming in interface MastodonApi

timelines

public Timelines timelines()

Specified by:

timelines in interface MastodonApi

instance

public Instance instance()

Description copied from interface: BaseMastodonApi

View server information

Obtain general information about the server.

Specified by:

instance in interface BaseMastodonApi

Returns:

a instance information object

search

public Search search(String query)

Description copied from interface: MastodonApi

Search for content in accounts, statuses and hashtags.

Specified by:

search in interface MastodonApi

Parameters:

query - the search query to execute

Returns:

a search result instance

search

public Search search(BaseMastodonApi.QueryOptions queryOptions)

Description copied from interface: BaseMastodonApi

Perform a search

Specified by:

search in interface BaseMastodonApi

Parameters:

queryOptions - query options record containing all query parameters

Returns:

a search result instance