🥮 mooncakes.io
README

marianoguerra/megalodon/client does not have a README file

#
Client

source
pub struct Client {
  transport : &
Transport
  base_url : String
  software : ServerSoftware
  access_token : String?
  user_agent : String
  extra_headers : Map[String, String]
}

#
Client::accept_follow_request

source

#
Client::add_accounts_to_list

source
async fn Client::add_accounts_to_list(self : Client, id : String, account_ids : Array[String]) -> 
Response[Json] raise 
MegalodonError

#
Client::add_reaction_to_announcement

source
async fn Client::add_reaction_to_announcement(self : Client, id : String, name : String) -> 
Response[Json] raise 
MegalodonError

#
Client::base_url

source
fn Client::base_url(self : Client) -> String

#
Client::block_account

source

#
Client::block_domain

source

#
Client::bookmark_status

source

#
Client::call

source

The complete REST escape hatch. Endpoint inventories every operation in the reference interface; query/body encoding remains explicit for forward compatibility with server extensions.

#
Client::cancel_scheduled_status

source

#
Client::create_app

source
async fn Client::create_app(self : Client, client_name : String, redirect_uris? : String, scopes? : Array[String], website? : String) -> 
AppData raise 
MegalodonError

#
Client::create_emoji_reaction

source

#
Client::create_filter

source

#
Client::create_list

source

#
Client::delete_accounts_from_list

source
async fn Client::delete_accounts_from_list(self : Client, id : String, account_ids : Array[String]) -> 
Response[Json] raise 
MegalodonError

#
Client::delete_conversation

source

#
Client::delete_emoji_reaction

source

#
Client::delete_filter

source

#
Client::delete_list

source

#
Client::delete_push_subscription

source

#
Client::delete_status

source

#
Client::dismiss_instance_announcement

source

#
Client::dismiss_notification

source

#
Client::dismiss_notifications

source

#
Client::edit_status

source
async fn Client::edit_status(self : Client, id : String, status? : String, media_ids? : Array[String], sensitive? : Bool, spoiler_text? : String, language? : String) -> 
Response[
Status] raise 
MegalodonError

#
Client::favourite_status

source

#
Client::fetch_access_token

source
async fn Client::fetch_access_token(self : Client, client_id : String, client_secret : String, code : String, redirect_uri? : String) -> 
TokenData raise 
MegalodonError

#
Client::follow_account

source

#
Client::follow_tag

source

#
Client::get_account

source

#
Client::get_account_favourites

source
async fn Client::get_account_favourites(self : Client, id : String, limit? : Int, max_id? : String, min_id? : String) -> 
Response[Array[
Status]] raise 
MegalodonError

#
Client::get_account_followers

source
async fn Client::get_account_followers(self : Client, id : String, limit? : Int, max_id? : String, since_id? : String) -> 
Response[Array[
Account]] raise 
MegalodonError

#
Client::get_account_following

source
async fn Client::get_account_following(self : Client, id : String, limit? : Int, max_id? : String, since_id? : String) -> 
Response[Array[
Account]] raise 
MegalodonError

#
Client::get_account_lists

source

#
Client::get_account_statuses

source
async fn Client::get_account_statuses(self : Client, id : String, limit? : Int, max_id? : String, since_id? : String, min_id? : String, pinned? : Bool, exclude_replies? : Bool, exclude_reblogs? : Bool, only_media? : Bool, only_public? : Bool) -> 
Response[Array[
Status]] raise 
MegalodonError

#
Client::get_accounts_in_list

source

#
Client::get_blocks

source

#
Client::get_bookmarks

source
async fn Client::get_bookmarks(self : Client, limit? : Int, max_id? : String, since_id? : String, min_id? : String) -> 
Response[Array[
Status]] raise 
MegalodonError

#
Client::get_conversation_timeline

source
async fn Client::get_conversation_timeline(self : Client, limit? : Int, max_id? : String, since_id? : String, min_id? : String) -> 
Response[Array[
EntityObject]] raise 
MegalodonError

#
Client::get_domain_blocks

source
async fn Client::get_domain_blocks(self : Client, limit? : Int, max_id? : String) -> 
Response[Array[String]] raise 
MegalodonError

#
Client::get_emoji_reaction

source

#
Client::get_emoji_reactions

source

#
Client::get_endorsements

source

#
Client::get_favourites

source

#
Client::get_filter

source

#
Client::get_filters

source

#
Client::get_follow_requests

source

#
Client::get_followed_tags

source

#
Client::get_home_timeline

source
async fn Client::get_home_timeline(self : Client, limit? : Int, max_id? : String, since_id? : String, min_id? : String) -> 
Response[Array[
Status]] raise 
MegalodonError

#
Client::get_identity_proofs

source

#
Client::get_instance

source

#
Client::get_instance_activity

source

#
Client::get_instance_announcements

source

#
Client::get_instance_custom_emojis

source

#
Client::get_instance_directory

source

#
Client::get_instance_peers

source

#
Client::get_list

source

#
Client::get_list_timeline

source
async fn Client::get_list_timeline(self : Client, list_id : String, limit? : Int, max_id? : String, since_id? : String, min_id? : String) -> 
Response[Array[
Status]] raise 
MegalodonError

#
Client::get_lists

source

#
Client::get_local_timeline

source
async fn Client::get_local_timeline(self : Client, limit? : Int, max_id? : String, since_id? : String, min_id? : String, only_media? : Bool) -> 
Response[Array[
Status]] raise 
MegalodonError

#
Client::get_markers

source

#
Client::get_media

source

#
Client::get_mutes

source

#
Client::get_notification

source

#
Client::get_notifications

source
async fn Client::get_notifications(self : Client, limit? : Int, max_id? : String, since_id? : String, min_id? : String, account_id? : String, exclude_types? : Array[
NotificationType]) -> 
Response[Array[
Notification]] raise 
MegalodonError

#
Client::get_poll

source

#
Client::get_preferences

source

#
Client::get_public_timeline

source
async fn Client::get_public_timeline(self : Client, limit? : Int, max_id? : String, since_id? : String, min_id? : String, only_media? : Bool, local_only? : Bool) -> 
Response[Array[
Status]] raise 
MegalodonError

#
Client::get_push_subscription

source

#
Client::get_relationships

source

#
Client::get_scheduled_status

source

#
Client::get_scheduled_statuses

source

#
Client::get_status

source

#
Client::get_status_context

source

#
Client::get_status_favourited_by

source

#
Client::get_status_reblogged_by

source

#
Client::get_status_source

source

#
Client::get_suggested_tags

source

#
Client::get_suggestions

source

#
Client::get_tag

source

#
Client::get_tag_timeline

source
async fn Client::get_tag_timeline(self : Client, hashtag : String, limit? : Int, max_id? : String, since_id? : String, min_id? : String, only_media? : Bool, local_only? : Bool) -> 
Response[Array[
Status]] raise 
MegalodonError

#
Client::lookup_account

source

#
Client::mute_account

source

#
Client::mute_status

source

#
Client::new

source
fn Client::new(transport : &
Transport, software : ServerSoftware, base_url : String, access_token? : String, user_agent? : String, extra_headers? : Map[String, String]) -> Client

#
Client::pin_account

source

#
Client::pin_status

source

#
Client::post_status

source
async fn Client::post_status(self : Client, status : String, media_ids? : Array[String], in_reply_to_id? : String, sensitive? : Bool, spoiler_text? : String, visibility? : 
StatusVisibility, scheduled_at? : String, language? : String, quote_id? : String) -> 
Response[Json] raise 
MegalodonError

#
Client::raw

source

Send a request outside the frozen endpoint inventory.

#
Client::read_conversation

source

#
Client::read_notifications

source

#
Client::reblog_status

source

#
Client::refresh_access_token

source
async fn Client::refresh_access_token(self : Client, client_id : String, client_secret : String, refresh_token : String) -> 
TokenData raise 
MegalodonError

#
Client::register_account

source

#
Client::register_app

source
async fn Client::register_app(self : Client, client_name : String, redirect_uris? : String, scopes? : Array[String], website? : String) -> 
AppData raise 
MegalodonError

#
Client::reject_follow_request

source

#
Client::remove_reaction_from_announcement

source
async fn Client::remove_reaction_from_announcement(self : Client, id : String, name : String) -> 
Response[Json] raise 
MegalodonError

#
Client::report

source

#
Client::revoke_access_token

source
async fn Client::revoke_access_token(self : Client, client_id : String, client_secret : String, token : String) -> 
Response[Json] raise 
MegalodonError

#
Client::save_markers

source

#
Client::schedule_status

source

#
Client::search

source
async fn Client::search(self : Client, q : String, search_type? : SearchType, limit? : Int, max_id? : String, min_id? : String, resolve? : Bool, offset? : Int64, following? : Bool, account_id? : String, exclude_unreviewed? : Bool) -> 
Response[
EntityObject] raise 
MegalodonError

#
Client::search_account

source
async fn Client::search_account(self : Client, q : String, following? : Bool, resolve? : Bool, limit? : Int, max_id? : String, since_id? : String) -> 
Response[Array[
Account]] raise 
MegalodonError

#
Client::set_account_note

source

#
Client::software

source
fn Client::software(self : Client) -> ServerSoftware

#
Client::subscribe_account

source

#
Client::subscribe_push_notification

source

#
Client::unblock_account

source

#
Client::unblock_domain

source

#
Client::unbookmark_status

source

#
Client::unfavourite_status

source

#
Client::unfollow_account

source

#
Client::unfollow_tag

source

#
Client::unmute_account

source

#
Client::unmute_status

source

#
Client::unpin_account

source

#
Client::unpin_status

source

#
Client::unreblog_status

source

#
Client::unsubscribe_account

source

#
Client::update_credentials

source

#
Client::update_filter

source

#
Client::update_list

source

#
Client::update_media

source

#
Client::update_push_subscription

source

#
Client::upload_media

source
async fn Client::upload_media(self : Client, bytes : Bytes, mime_type : String, file_name? : String, description? : String, focus? : String, boundary? : String) -> 
Response[
UploadMedia] raise 
MegalodonError

#
Client::verify_account_credentials

source

#
Client::verify_app_credentials

source

#
Client::vote_poll

source

#
DirectoryOrder

source
pub(all) enum DirectoryOrder {
  Active
  New
} derive(Eq, 
Debug)

#
DirectoryOrder::to_string

source
fn DirectoryOrder::to_string(self : DirectoryOrder) -> String

#
Endpoint

source
pub(all) enum Endpoint {
  CreateApp
  FetchAccessToken
  RefreshAccessToken
  RevokeAccessToken
  VerifyAppCredentials
  RegisterAccount
  VerifyAccountCredentials
  UpdateCredentials
  GetAccount(String)
  GetAccountStatuses(String)
  GetAccountFavourites(String)
  SubscribeAccount(String)
  UnsubscribeAccount(String)
  GetAccountFollowers(String)
  GetAccountFollowing(String)
  GetAccountLists(String)
  GetIdentityProofs(String)
  FollowAccount(String)
  UnfollowAccount(String)
  BlockAccount(String)
  UnblockAccount(String)
  MuteAccount(String)
  UnmuteAccount(String)
  PinAccount(String)
  UnpinAccount(String)
  SetAccountNote(String)
  GetRelationships
  SearchAccount
  LookupAccount
  GetBookmarks
  GetFavourites
  GetMutes
  GetBlocks
  GetDomainBlocks
  BlockDomain
  UnblockDomain
  GetFilters
  GetFilter(String)
  CreateFilter
  UpdateFilter(String)
  DeleteFilter(String)
  Report
  GetFollowRequests
  AcceptFollowRequest(String)
  RejectFollowRequest(String)
  GetEndorsements
  GetFeaturedTags
  CreateFeaturedTag
  DeleteFeaturedTag(String)
  GetSuggestedTags
  GetPreferences
  GetFollowedTags
  GetSuggestions
  GetTag(String)
  FollowTag(String)
  UnfollowTag(String)
  PostStatus
  GetStatus(String)
  GetStatusSource(String)
  EditStatus(String)
  DeleteStatus(String)
  GetStatusContext(String)
  GetStatusRebloggedBy(String)
  GetStatusFavouritedBy(String)
  FavouriteStatus(String)
  UnfavouriteStatus(String)
  ReblogStatus(String)
  UnreblogStatus(String)
  BookmarkStatus(String)
  UnbookmarkStatus(String)
  MuteStatus(String)
  UnmuteStatus(String)
  PinStatus(String)
  UnpinStatus(String)
  UploadMedia
  GetMedia(String)
  UpdateMedia(String)
  GetPoll(String)
  VotePoll(String)
  GetScheduledStatuses
  GetScheduledStatus(String)
  ScheduleStatus(String)
  CancelScheduledStatus(String)
  GetPublicTimeline
  GetLocalTimeline
  GetTagTimeline(String)
  GetHomeTimeline
  GetListTimeline(String)
  GetConversationTimeline
  DeleteConversation(String)
  ReadConversation(String)
  GetLists
  GetList(String)
  CreateList
  UpdateList(String)
  DeleteList(String)
  GetAccountsInList(String)
  AddAccountsToList(String)
  DeleteAccountsFromList(String)
  GetMarkers
  SaveMarkers
  GetNotifications
  GetNotification(String)
  DismissNotifications
  DismissNotification(String)
  ReadNotifications
  SubscribePushNotification
  GetPushSubscription
  UpdatePushSubscription
  DeletePushSubscription
  Search
  GetInstance
  GetInstancePeers
  GetInstanceActivity
  GetInstanceTrends
  GetInstanceDirectory
  GetInstanceCustomEmojis
  GetInstanceAnnouncements
  DismissInstanceAnnouncement(String)
  AddReactionToAnnouncement(id~ : String, name~ : String)
  RemoveReactionFromAnnouncement(id~ : String, name~ : String)
  CreateEmojiReaction(id~ : String, emoji~ : String)
  DeleteEmojiReaction(id~ : String, emoji~ : String)
  GetEmojiReactions(String)
  GetEmojiReaction(id~ : String, emoji~ : String)
} derive(Eq, 
Debug)

The complete non-streaming, non-admin operation inventory from megalodon-rs/src/megalodon.rs at the revision recorded in provenance.

#
Endpoint::http_method

source

#
Endpoint::path

source
fn Endpoint::path(self : Endpoint) -> String

#
PollOptions

source
pub(all) struct PollOptions {
  options : Array[String]
  expires_in : Int64?
  multiple : Bool?
  hide_totals : Bool?
} derive(Eq, 
Debug)

#
SearchType

source
pub(all) enum SearchType {
  Accounts
  Hashtags
  Statuses
} derive(Eq, 
Debug)

#
SearchType::to_string

source
fn SearchType::to_string(self : SearchType) -> String

#
ServerSoftware

source
pub(all) enum ServerSoftware {
  Mastodon
  Pleroma
  Friendica
  Firefish
  GoToSocial
  Pixelfed
  Akkoma
  Hometown
  Iceshrimp
  Unknown(String)
} derive(Eq, 
Debug)

#
ServerSoftware::parse

source
fn ServerSoftware::parse(value : String) -> ServerSoftware

#
ServerSoftware::to_string

source
fn ServerSoftware::to_string(self : ServerSoftware) -> String

#
authorization_url

source
fn authorization_url(base_url : String, client_id : String, redirect_uri? : String, scopes? : Array[String]) -> String

#
page_params

source
fn page_params(limit? : Int, max_id? : String, since_id? : String, min_id? : String) -> 
Params

Pagination accepted by most collection endpoints.

Source Files

Powered by MoonBit

Site sourceReport issuePackagesBuild queueSkillsStatistics

© 2026 mooncakes.io