756 lines
387 KiB
HTML
756 lines
387 KiB
HTML
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>MegalodonInterface | megalodon</title><meta name="description" content="Documentation for megalodon"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">megalodon</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">megalodon</a></li><li><a href="MegalodonInterface.html">MegalodonInterface</a></li></ul><h1>Interface MegalodonInterface</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">MegalodonInterface</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/Mastodon.html" class="tsd-signature-type" data-tsd-kind="Class">Mastodon</a></li><li><a href="../classes/Misskey.html" class="tsd-signature-type" data-tsd-kind="Class">Misskey</a></li><li><a href="../classes/Pleroma.html" class="tsd-signature-type" data-tsd-kind="Class">Pleroma</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#acceptFollowRequest" class="tsd-kind-icon">accept<wbr/>Follow<wbr/>Request</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#addAccountsToList" class="tsd-kind-icon">add<wbr/>Accounts<wbr/>To<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#blockAccount" class="tsd-kind-icon">block<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#blockDomain" class="tsd-kind-icon">block<wbr/>Domain</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#bookmarkStatus" class="tsd-kind-icon">bookmark<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#cancel" class="tsd-kind-icon">cancel</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#cancelScheduledStatus" class="tsd-kind-icon">cancel<wbr/>Scheduled<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#createApp" class="tsd-kind-icon">create<wbr/>App</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#createEmojiReaction" class="tsd-kind-icon">create<wbr/>Emoji<wbr/>Reaction</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#createFeaturedTag" class="tsd-kind-icon">create<wbr/>Featured<wbr/>Tag</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#createFilter" class="tsd-kind-icon">create<wbr/>Filter</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#createList" class="tsd-kind-icon">create<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteAccountsFromList" class="tsd-kind-icon">delete<wbr/>Accounts<wbr/>From<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteConversation" class="tsd-kind-icon">delete<wbr/>Conversation</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteEmojiReaction" class="tsd-kind-icon">delete<wbr/>Emoji<wbr/>Reaction</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteFeaturedTag" class="tsd-kind-icon">delete<wbr/>Featured<wbr/>Tag</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteFilter" class="tsd-kind-icon">delete<wbr/>Filter</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteList" class="tsd-kind-icon">delete<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deletePushSubscription" class="tsd-kind-icon">delete<wbr/>Push<wbr/>Subscription</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteStatus" class="tsd-kind-icon">delete<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#directSocket" class="tsd-kind-icon">direct<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#directStream" class="tsd-kind-icon">direct<wbr/>Stream</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#dismissNotification" class="tsd-kind-icon">dismiss<wbr/>Notification</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#dismissNotifications" class="tsd-kind-icon">dismiss<wbr/>Notifications</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#favouriteStatus" class="tsd-kind-icon">favourite<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#fetchAccessToken" class="tsd-kind-icon">fetch<wbr/>Access<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#followAccount" class="tsd-kind-icon">follow<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccount" class="tsd-kind-icon">get<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccountFavourites" class="tsd-kind-icon">get<wbr/>Account<wbr/>Favourites</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccountFollowers" class="tsd-kind-icon">get<wbr/>Account<wbr/>Followers</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccountFollowing" class="tsd-kind-icon">get<wbr/>Account<wbr/>Following</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccountLists" class="tsd-kind-icon">get<wbr/>Account<wbr/>Lists</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccountStatuses" class="tsd-kind-icon">get<wbr/>Account<wbr/>Statuses</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccountsInList" class="tsd-kind-icon">get<wbr/>Accounts<wbr/>In<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getBlocks" class="tsd-kind-icon">get<wbr/>Blocks</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getBookmarks" class="tsd-kind-icon">get<wbr/>Bookmarks</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getConversationTimeline" class="tsd-kind-icon">get<wbr/>Conversation<wbr/>Timeline</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getDomainBlocks" class="tsd-kind-icon">get<wbr/>Domain<wbr/>Blocks</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getEmojiReaction" class="tsd-kind-icon">get<wbr/>Emoji<wbr/>Reaction</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getEmojiReactions" class="tsd-kind-icon">get<wbr/>Emoji<wbr/>Reactions</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getEndorsements" class="tsd-kind-icon">get<wbr/>Endorsements</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getFavourites" class="tsd-kind-icon">get<wbr/>Favourites</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getFeaturedTags" class="tsd-kind-icon">get<wbr/>Featured<wbr/>Tags</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getFilter" class="tsd-kind-icon">get<wbr/>Filter</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getFilters" class="tsd-kind-icon">get<wbr/>Filters</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getFollowRequests" class="tsd-kind-icon">get<wbr/>Follow<wbr/>Requests</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getHomeTimeline" class="tsd-kind-icon">get<wbr/>Home<wbr/>Timeline</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getIdentityProof" class="tsd-kind-icon">get<wbr/>Identity<wbr/>Proof</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getInstance" class="tsd-kind-icon">get<wbr/>Instance</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getInstanceActivity" class="tsd-kind-icon">get<wbr/>Instance<wbr/>Activity</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getInstanceCustomEmojis" class="tsd-kind-icon">get<wbr/>Instance<wbr/>Custom<wbr/>Emojis</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getInstanceDirectory" class="tsd-kind-icon">get<wbr/>Instance<wbr/>Directory</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getInstancePeers" class="tsd-kind-icon">get<wbr/>Instance<wbr/>Peers</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getInstanceTrends" class="tsd-kind-icon">get<wbr/>Instance<wbr/>Trends</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getList" class="tsd-kind-icon">get<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getListTimeline" class="tsd-kind-icon">get<wbr/>List<wbr/>Timeline</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getLists" class="tsd-kind-icon">get<wbr/>Lists</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getLocalTimeline" class="tsd-kind-icon">get<wbr/>Local<wbr/>Timeline</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getMarkers" class="tsd-kind-icon">get<wbr/>Markers</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getMutes" class="tsd-kind-icon">get<wbr/>Mutes</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getNotification" class="tsd-kind-icon">get<wbr/>Notification</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getNotifications" class="tsd-kind-icon">get<wbr/>Notifications</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getPoll" class="tsd-kind-icon">get<wbr/>Poll</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getPreferences" class="tsd-kind-icon">get<wbr/>Preferences</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getPublicTimeline" class="tsd-kind-icon">get<wbr/>Public<wbr/>Timeline</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getPushSubscription" class="tsd-kind-icon">get<wbr/>Push<wbr/>Subscription</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getRelationship" class="tsd-kind-icon">get<wbr/>Relationship</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getRelationships" class="tsd-kind-icon">get<wbr/>Relationships</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getScheduledStatus" class="tsd-kind-icon">get<wbr/>Scheduled<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getScheduledStatuses" class="tsd-kind-icon">get<wbr/>Scheduled<wbr/>Statuses</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getStatus" class="tsd-kind-icon">get<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getStatusContext" class="tsd-kind-icon">get<wbr/>Status<wbr/>Context</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getStatusFavouritedBy" class="tsd-kind-icon">get<wbr/>Status<wbr/>Favourited<wbr/>By</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getStatusRebloggedBy" class="tsd-kind-icon">get<wbr/>Status<wbr/>Reblogged<wbr/>By</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getSuggestedTags" class="tsd-kind-icon">get<wbr/>Suggested<wbr/>Tags</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getSuggestions" class="tsd-kind-icon">get<wbr/>Suggestions</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getTagTimeline" class="tsd-kind-icon">get<wbr/>Tag<wbr/>Timeline</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#listSocket" class="tsd-kind-icon">list<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#listStream" class="tsd-kind-icon">list<wbr/>Stream</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#localSocket" class="tsd-kind-icon">local<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#localStream" class="tsd-kind-icon">local<wbr/>Stream</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#muteAccount" class="tsd-kind-icon">mute<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#muteStatus" class="tsd-kind-icon">mute<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#pinAccount" class="tsd-kind-icon">pin<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#pinStatus" class="tsd-kind-icon">pin<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#postStatus" class="tsd-kind-icon">post<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#publicSocket" class="tsd-kind-icon">public<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#publicStream" class="tsd-kind-icon">public<wbr/>Stream</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#readConversation" class="tsd-kind-icon">read<wbr/>Conversation</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#reblogStatus" class="tsd-kind-icon">reblog<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#refreshToken" class="tsd-kind-icon">refresh<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#registerAccount" class="tsd-kind-icon">register<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#registerApp" class="tsd-kind-icon">register<wbr/>App</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#rejectFollowRequest" class="tsd-kind-icon">reject<wbr/>Follow<wbr/>Request</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#report" class="tsd-kind-icon">report</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#revokeToken" class="tsd-kind-icon">revoke<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#saveMarkers" class="tsd-kind-icon">save<wbr/>Markers</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#scheduleStatus" class="tsd-kind-icon">schedule<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#search" class="tsd-kind-icon">search</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#searchAccount" class="tsd-kind-icon">search<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#subscribeAccount" class="tsd-kind-icon">subscribe<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#subscribePushNotification" class="tsd-kind-icon">subscribe<wbr/>Push<wbr/>Notification</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#tagSocket" class="tsd-kind-icon">tag<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#tagStream" class="tsd-kind-icon">tag<wbr/>Stream</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unblockAccount" class="tsd-kind-icon">unblock<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unblockDomain" class="tsd-kind-icon">unblock<wbr/>Domain</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unbookmarkStatus" class="tsd-kind-icon">unbookmark<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unfavouriteStatus" class="tsd-kind-icon">unfavourite<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unfollowAccount" class="tsd-kind-icon">unfollow<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unmuteAccount" class="tsd-kind-icon">unmute<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unmuteStatus" class="tsd-kind-icon">unmute<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unpinAccount" class="tsd-kind-icon">unpin<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unpinStatus" class="tsd-kind-icon">unpin<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unreblogStatus" class="tsd-kind-icon">unreblog<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unsubscribeAccount" class="tsd-kind-icon">unsubscribe<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#updateCredentials" class="tsd-kind-icon">update<wbr/>Credentials</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#updateFilter" class="tsd-kind-icon">update<wbr/>Filter</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#updateList" class="tsd-kind-icon">update<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#updateMedia" class="tsd-kind-icon">update<wbr/>Media</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#updatePushSubscription" class="tsd-kind-icon">update<wbr/>Push<wbr/>Subscription</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#uploadMedia" class="tsd-kind-icon">upload<wbr/>Media</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#userSocket" class="tsd-kind-icon">user<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#userStream" class="tsd-kind-icon">user<wbr/>Stream</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#verifyAccountCredentials" class="tsd-kind-icon">verify<wbr/>Account<wbr/>Credentials</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#verifyAppCredentials" class="tsd-kind-icon">verify<wbr/>App<wbr/>Credentials</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#votePoll" class="tsd-kind-icon">vote<wbr/>Poll</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="acceptFollowRequest" class="tsd-anchor"></a><h3>accept<wbr/>Follow<wbr/>Request</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">accept<wbr/>Follow<wbr/>Request<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L529">src/megalodon.ts:529</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/follow_requests/:id/authorize</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Relationship.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="addAccountsToList" class="tsd-anchor"></a><h3>add<wbr/>Accounts<wbr/>To<wbr/>List</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Accounts<wbr/>To<wbr/>List<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, account_ids<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1010">src/megalodon.ts:1010</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/lists/:id/accounts</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target list ID.</p>
|
|
</div></div></li><li><h5>account_ids: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array of account IDs to add to the list.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="blockAccount" class="tsd-anchor"></a><h3>block<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">block<wbr/>Account<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L294">src/megalodon.ts:294</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/accounts/:id/block</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Relationship</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="blockDomain" class="tsd-anchor"></a><h3>block<wbr/>Domain</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">block<wbr/>Domain<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L430">src/megalodon.ts:430</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST/api/v1/domain_blocks</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>domain: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Domain to block.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="bookmarkStatus" class="tsd-anchor"></a><h3>bookmark<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">bookmark<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L699">src/megalodon.ts:699</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/statuses/:id/bookmark</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="cancel" class="tsd-anchor"></a><h3>cancel</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">cancel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L36">src/megalodon.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Cancel all requests in this instance.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>void</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="cancelScheduledStatus" class="tsd-anchor"></a><h3>cancel<wbr/>Scheduled<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">cancel<wbr/>Scheduled<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L821">src/megalodon.ts:821</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>DELETE /api/v1/scheduled_statuses/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target scheduled status ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="createApp" class="tsd-anchor"></a><h3>create<wbr/>App</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">create<wbr/>App<span class="tsd-signature-symbol">(</span>client_name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>redirect_uris<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>scopes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>website<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/OAuth.AppData.html" class="tsd-signature-type" data-tsd-kind="Class">AppData</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L56">src/megalodon.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Call /api/v1/apps</p>
|
|
</div><div><p>Create an application.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client_name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>your application's name</p>
|
|
</div></div></li><li><h5>options: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>redirect_uris<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>scopes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>website<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Form Data</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/OAuth.AppData.html" class="tsd-signature-type" data-tsd-kind="Class">AppData</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="createEmojiReaction" class="tsd-anchor"></a><h3>create<wbr/>Emoji<wbr/>Reaction</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">create<wbr/>Emoji<wbr/>Reaction<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, emoji<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1210">src/megalodon.ts:1210</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5></li><li><h5>emoji: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="createFeaturedTag" class="tsd-anchor"></a><h3>create<wbr/>Featured<wbr/>Tag</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">create<wbr/>Featured<wbr/>Tag<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#FeaturedTag" class="tsd-signature-type" data-tsd-kind="Type alias">FeaturedTag</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L564">src/megalodon.ts:564</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/featured_tags</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target hashtag name.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#FeaturedTag" class="tsd-signature-type" data-tsd-kind="Type alias">FeaturedTag</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>FeaturedTag.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="createFilter" class="tsd-anchor"></a><h3>create<wbr/>Filter</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">create<wbr/>Filter<span class="tsd-signature-symbol">(</span>phrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>expires_in<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>irreversible<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>whole_word<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L463">src/megalodon.ts:463</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/filters</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>phrase: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Text to be filtered.</p>
|
|
</div></div></li><li><h5>context: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>expires_in<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>irreversible<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>whole_word<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> expires_<wbr/>in<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>ISO 8601 Datetime for when the filter expires.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> irreversible<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Should the server irreversibly drop matching entities from home and notifications?</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> whole_<wbr/>word<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Consider word boundaries?</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Filter</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="createList" class="tsd-anchor"></a><h3>create<wbr/>List</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">create<wbr/>List<span class="tsd-signature-symbol">(</span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#List" class="tsd-signature-type" data-tsd-kind="Type alias">List</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L971">src/megalodon.ts:971</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/lists</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>title: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>List name.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#List" class="tsd-signature-type" data-tsd-kind="Type alias">List</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>List.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="deleteAccountsFromList" class="tsd-anchor"></a><h3>delete<wbr/>Accounts<wbr/>From<wbr/>List</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Accounts<wbr/>From<wbr/>List<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, account_ids<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1017">src/megalodon.ts:1017</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>DELETE /api/v1/lists/:id/accounts</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target list ID.</p>
|
|
</div></div></li><li><h5>account_ids: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array of account IDs to add to the list.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="deleteConversation" class="tsd-anchor"></a><h3>delete<wbr/>Conversation</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Conversation<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L941">src/megalodon.ts:941</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>DELETE /api/v1/conversations/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target conversation ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="deleteEmojiReaction" class="tsd-anchor"></a><h3>delete<wbr/>Emoji<wbr/>Reaction</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Emoji<wbr/>Reaction<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, emoji<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1211">src/megalodon.ts:1211</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5></li><li><h5>emoji: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="deleteFeaturedTag" class="tsd-anchor"></a><h3>delete<wbr/>Featured<wbr/>Tag</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Featured<wbr/>Tag<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L571">src/megalodon.ts:571</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>DELETE /api/v1/featured_tags/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target featured tag id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Empty</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="deleteFilter" class="tsd-anchor"></a><h3>delete<wbr/>Filter</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Filter<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L499">src/megalodon.ts:499</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>DELETE /api/v1/filters/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The filter ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Removed filter.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="deleteList" class="tsd-anchor"></a><h3>delete<wbr/>List</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">delete<wbr/>List<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L985">src/megalodon.ts:985</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>DELETE /api/v1/lists/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target list ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="deletePushSubscription" class="tsd-anchor"></a><h3>delete<wbr/>Push<wbr/>Subscription</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Push<wbr/>Subscription<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1117">src/megalodon.ts:1117</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>DELETE /api/v1/push/subscription</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="deleteStatus" class="tsd-anchor"></a><h3>delete<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L642">src/megalodon.ts:642</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>DELETE /api/v1/statuses/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="directSocket" class="tsd-anchor"></a><h3>direct<wbr/>Socket</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">direct<wbr/>Socket<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WebSocketInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketInterface</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1233">src/megalodon.ts:1233</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="WebSocketInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketInterface</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="directStream" class="tsd-anchor"></a><h3>direct<wbr/>Stream</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">direct<wbr/>Stream<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="StreamListenerInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamListenerInterface</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1223">src/megalodon.ts:1223</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="StreamListenerInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamListenerInterface</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="dismissNotification" class="tsd-anchor"></a><h3>dismiss<wbr/>Notification</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">dismiss<wbr/>Notification<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1074">src/megalodon.ts:1074</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/notifications/:id/dismiss</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target notification ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="dismissNotifications" class="tsd-anchor"></a><h3>dismiss<wbr/>Notifications</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">dismiss<wbr/>Notifications<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1068">src/megalodon.ts:1068</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/notifications/clear</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="favouriteStatus" class="tsd-anchor"></a><h3>favourite<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">favourite<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L671">src/megalodon.ts:671</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/statuses/:id/favourite</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="fetchAccessToken" class="tsd-anchor"></a><h3>fetch<wbr/>Access<wbr/>Token</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">fetch<wbr/>Access<wbr/>Token<span class="tsd-signature-symbol">(</span>client_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, client_secret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, redirect_uri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/OAuth.TokenData.html" class="tsd-signature-type" data-tsd-kind="Class">TokenData</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L85">src/megalodon.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /oauth/token</p>
|
|
</div><div><p>Fetch OAuth access token.
|
|
Get an access token based client_id and client_secret and authorization code.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client_id: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>will be generated by #createApp or #registerApp</p>
|
|
</div></div></li><li><h5>client_secret: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>will be generated by #createApp or #registerApp</p>
|
|
</div></div></li><li><h5>code: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>will be generated by the link of #generateAuthUrl or #registerApp</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> redirect_uri: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>must be the same uri as the time when you register your OAuth application</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/OAuth.TokenData.html" class="tsd-signature-type" data-tsd-kind="Class">TokenData</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="followAccount" class="tsd-anchor"></a><h3>follow<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">follow<wbr/>Account<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>reblog<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L275">src/megalodon.ts:275</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/accounts/:id/follow</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>reblog<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> reblog<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Relationship</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getAccount" class="tsd-anchor"></a><h3>get<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Account<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L162">src/megalodon.ts:162</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/accounts/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>An account.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getAccountFavourites" class="tsd-anchor"></a><h3>get<wbr/>Account<wbr/>Favourites</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Account<wbr/>Favourites<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L198">src/megalodon.ts:198</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/pleroma/accounts/:id/favourites</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target account ID.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results order than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of statuses.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getAccountFollowers" class="tsd-anchor"></a><h3>get<wbr/>Account<wbr/>Followers</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Account<wbr/>Followers<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L229">src/megalodon.ts:229</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/accounts/:id/followers</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>The array of accounts.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getAccountFollowing" class="tsd-anchor"></a><h3>get<wbr/>Account<wbr/>Following</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Account<wbr/>Following<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L246">src/megalodon.ts:246</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/accounts/:id/following</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>The array of accounts.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getAccountLists" class="tsd-anchor"></a><h3>get<wbr/>Account<wbr/>Lists</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Account<wbr/>Lists<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#List" class="tsd-signature-type" data-tsd-kind="Type alias">List</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L260">src/megalodon.ts:260</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/accounts/:id/lists</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#List" class="tsd-signature-type" data-tsd-kind="Type alias">List</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>The array of lists.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getAccountStatuses" class="tsd-anchor"></a><h3>get<wbr/>Account<wbr/>Statuses</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Account<wbr/>Statuses<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>exclude_reblogs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>exclude_replies<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>only_media<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>pinned<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L177">src/megalodon.ts:177</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/accounts/:id/statuses</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>exclude_reblogs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>exclude_replies<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>only_media<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>pinned<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> exclude_<wbr/>reblogs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return statuses which exclude reblogs.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> exclude_<wbr/>replies<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return statuses which exclude replies.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> only_<wbr/>media<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Show only statuses with media attached? Defaults to false.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> pinned<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return statuses which include pinned statuses.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Account's statuses.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getAccountsInList" class="tsd-anchor"></a><h3>get<wbr/>Accounts<wbr/>In<wbr/>List</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Accounts<wbr/>In<wbr/>List<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L996">src/megalodon.ts:996</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/lists/:id/accounts</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target list ID.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of accounts.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getBlocks" class="tsd-anchor"></a><h3>get<wbr/>Blocks</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Blocks<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L412">src/megalodon.ts:412</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/blocks</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of accounts.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getBookmarks" class="tsd-anchor"></a><h3>get<wbr/>Bookmarks</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Bookmarks<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L376">src/megalodon.ts:376</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/bookmarks</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of statuses.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getConversationTimeline" class="tsd-anchor"></a><h3>get<wbr/>Conversation<wbr/>Timeline</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Conversation<wbr/>Timeline<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Conversation" class="tsd-signature-type" data-tsd-kind="Type alias">Conversation</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L930">src/megalodon.ts:930</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/conversations</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Conversation" class="tsd-signature-type" data-tsd-kind="Type alias">Conversation</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of statuses.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getDomainBlocks" class="tsd-anchor"></a><h3>get<wbr/>Domain<wbr/>Blocks</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Domain<wbr/>Blocks<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L424">src/megalodon.ts:424</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/domain_blocks</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of domain name.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getEmojiReaction" class="tsd-anchor"></a><h3>get<wbr/>Emoji<wbr/>Reaction</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Emoji<wbr/>Reaction<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, emoji<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Reaction" class="tsd-signature-type" data-tsd-kind="Type alias">Reaction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1213">src/megalodon.ts:1213</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5></li><li><h5>emoji: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Reaction" class="tsd-signature-type" data-tsd-kind="Type alias">Reaction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getEmojiReactions" class="tsd-anchor"></a><h3>get<wbr/>Emoji<wbr/>Reactions</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Emoji<wbr/>Reactions<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Reaction" class="tsd-signature-type" data-tsd-kind="Type alias">Reaction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1212">src/megalodon.ts:1212</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Reaction" class="tsd-signature-type" data-tsd-kind="Type alias">Reaction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getEndorsements" class="tsd-anchor"></a><h3>get<wbr/>Endorsements</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Endorsements<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L548">src/megalodon.ts:548</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/endorsements</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of accounts.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getFavourites" class="tsd-anchor"></a><h3>get<wbr/>Favourites</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Favourites<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L388">src/megalodon.ts:388</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/favourites</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of statuses.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getFeaturedTags" class="tsd-anchor"></a><h3>get<wbr/>Featured<wbr/>Tags</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Featured<wbr/>Tags<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#FeaturedTag" class="tsd-signature-type" data-tsd-kind="Type alias">FeaturedTag</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L557">src/megalodon.ts:557</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/featured_tags</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#FeaturedTag" class="tsd-signature-type" data-tsd-kind="Type alias">FeaturedTag</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of featured tag.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getFilter" class="tsd-anchor"></a><h3>get<wbr/>Filter</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Filter<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L452">src/megalodon.ts:452</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/filters/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The filter ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Filter.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getFilters" class="tsd-anchor"></a><h3>get<wbr/>Filters</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Filters<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L445">src/megalodon.ts:445</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/filters</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of filters.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getFollowRequests" class="tsd-anchor"></a><h3>get<wbr/>Follow<wbr/>Requests</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Follow<wbr/>Requests<span class="tsd-signature-symbol">(</span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L522">src/megalodon.ts:522</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/follow_requests</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Maximum number of results.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of account.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getHomeTimeline" class="tsd-anchor"></a><h3>get<wbr/>Home<wbr/>Timeline</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Home<wbr/>Timeline<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>local<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L892">src/megalodon.ts:892</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/timelines/home</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>local<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> local<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Show only local statuses? Defaults to false.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of statuses.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getIdentityProof" class="tsd-anchor"></a><h3>get<wbr/>Identity<wbr/>Proof</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Identity<wbr/>Proof<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#IdentityProof" class="tsd-signature-type" data-tsd-kind="Type alias">IdentityProof</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L267">src/megalodon.ts:267</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/accounts/:id/identity_proofs</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#IdentityProof" class="tsd-signature-type" data-tsd-kind="Type alias">IdentityProof</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of IdentityProof</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getInstance" class="tsd-anchor"></a><h3>get<wbr/>Instance</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Instance<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Instance" class="tsd-signature-type" data-tsd-kind="Type alias">Instance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1156">src/megalodon.ts:1156</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/instance</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Instance" class="tsd-signature-type" data-tsd-kind="Type alias">Instance</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getInstanceActivity" class="tsd-anchor"></a><h3>get<wbr/>Instance<wbr/>Activity</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Instance<wbr/>Activity<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Activity" class="tsd-signature-type" data-tsd-kind="Type alias">Activity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1166">src/megalodon.ts:1166</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/instance/activity</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Activity" class="tsd-signature-type" data-tsd-kind="Type alias">Activity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getInstanceCustomEmojis" class="tsd-anchor"></a><h3>get<wbr/>Instance<wbr/>Custom<wbr/>Emojis</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Instance<wbr/>Custom<wbr/>Emojis<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Emoji" class="tsd-signature-type" data-tsd-kind="Type alias">Emoji</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1205">src/megalodon.ts:1205</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/custom_emojis</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Emoji" class="tsd-signature-type" data-tsd-kind="Type alias">Emoji</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of emojis.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getInstanceDirectory" class="tsd-anchor"></a><h3>get<wbr/>Instance<wbr/>Directory</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Instance<wbr/>Directory<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>local<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>order<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"active"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"new"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1190">src/megalodon.ts:1190</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/directory</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>local<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>order<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"active"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"new"</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>How many accounts to load. Default 40.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> local<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Only return local accounts.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>How many accounts to skip before returning results. Default 0.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> order<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"active"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"new"</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Order of results.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of accounts.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getInstancePeers" class="tsd-anchor"></a><h3>get<wbr/>Instance<wbr/>Peers</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Instance<wbr/>Peers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1161">src/megalodon.ts:1161</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/instance/peers</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getInstanceTrends" class="tsd-anchor"></a><h3>get<wbr/>Instance<wbr/>Trends</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Instance<wbr/>Trends<span class="tsd-signature-symbol">(</span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Tag" class="tsd-signature-type" data-tsd-kind="Type alias">Tag</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1176">src/megalodon.ts:1176</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/trends</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Maximum number of results to return. Defaults to 10.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Tag" class="tsd-signature-type" data-tsd-kind="Type alias">Tag</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getList" class="tsd-anchor"></a><h3>get<wbr/>List</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>List<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#List" class="tsd-signature-type" data-tsd-kind="Type alias">List</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L964">src/megalodon.ts:964</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/lists/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target list ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#List" class="tsd-signature-type" data-tsd-kind="Type alias">List</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>List.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getListTimeline" class="tsd-anchor"></a><h3>get<wbr/>List<wbr/>Timeline</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>List<wbr/>Timeline<span class="tsd-signature-symbol">(</span>list_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L909">src/megalodon.ts:909</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/timelines/list/:list_id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>list_id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Local ID of the list in the database.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of statuses.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getLists" class="tsd-anchor"></a><h3>get<wbr/>Lists</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Lists<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#List" class="tsd-signature-type" data-tsd-kind="Type alias">List</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L957">src/megalodon.ts:957</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/lists</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#List" class="tsd-signature-type" data-tsd-kind="Type alias">List</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of lists.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getLocalTimeline" class="tsd-anchor"></a><h3>get<wbr/>Local<wbr/>Timeline</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Local<wbr/>Timeline<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>only_media<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L852">src/megalodon.ts:852</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/timelines/public</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>only_media<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> only_<wbr/>media<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Show only statuses with media attached? Defaults to false.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of statuses.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getMarkers" class="tsd-anchor"></a><h3>get<wbr/>Markers</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Markers<span class="tsd-signature-symbol">(</span>timeline<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> | </span><a href="../modules/Entity.html#Marker" class="tsd-signature-type" data-tsd-kind="Type alias">Marker</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1027">src/megalodon.ts:1027</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/markers</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>timeline: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> | </span><a href="../modules/Entity.html#Marker" class="tsd-signature-type" data-tsd-kind="Type alias">Marker</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Marker or empty object.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getMutes" class="tsd-anchor"></a><h3>get<wbr/>Mutes</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Mutes<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L400">src/megalodon.ts:400</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/mutes</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of accounts.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getNotification" class="tsd-anchor"></a><h3>get<wbr/>Notification</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Notification<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Notification" class="tsd-signature-type" data-tsd-kind="Type alias">Notification</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1064">src/megalodon.ts:1064</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/notifications/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target notification ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Notification" class="tsd-signature-type" data-tsd-kind="Type alias">Notification</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Notification.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getNotifications" class="tsd-anchor"></a><h3>get<wbr/>Notifications</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Notifications<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>account_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>exclude_types<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Notification" class="tsd-signature-type" data-tsd-kind="Type alias">Notification</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1050">src/megalodon.ts:1050</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/notifications</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>account_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>exclude_types<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> account_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return only notifications received from this account.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> exclude_<wbr/>types<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array of types to exclude.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Notification" class="tsd-signature-type" data-tsd-kind="Type alias">Notification</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of notifications.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getPoll" class="tsd-anchor"></a><h3>get<wbr/>Poll</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Poll<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Poll" class="tsd-signature-type" data-tsd-kind="Type alias">Poll</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L774">src/megalodon.ts:774</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/polls/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target poll ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Poll" class="tsd-signature-type" data-tsd-kind="Type alias">Poll</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Poll</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getPreferences" class="tsd-anchor"></a><h3>get<wbr/>Preferences</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Preferences<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Preferences" class="tsd-signature-type" data-tsd-kind="Type alias">Preferences</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L586">src/megalodon.ts:586</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/preferences</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Preferences" class="tsd-signature-type" data-tsd-kind="Type alias">Preferences</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Preferences.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getPublicTimeline" class="tsd-anchor"></a><h3>get<wbr/>Public<wbr/>Timeline</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Public<wbr/>Timeline<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>only_media<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L835">src/megalodon.ts:835</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/timelines/public</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>only_media<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> only_<wbr/>media<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Show only statuses with media attached? Defaults to false.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of statuses.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getPushSubscription" class="tsd-anchor"></a><h3>get<wbr/>Push<wbr/>Subscription</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Push<wbr/>Subscription<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#PushSubscription" class="tsd-signature-type" data-tsd-kind="Type alias">PushSubscription</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1100">src/megalodon.ts:1100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/push/subscription</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#PushSubscription" class="tsd-signature-type" data-tsd-kind="Type alias">PushSubscription</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>PushSubscription.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getRelationship" class="tsd-anchor"></a><h3>get<wbr/>Relationship</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Relationship<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L337">src/megalodon.ts:337</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/accounts/relationships</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Relationship</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getRelationships" class="tsd-anchor"></a><h3>get<wbr/>Relationships</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Relationships<span class="tsd-signature-symbol">(</span>ids<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L344">src/megalodon.ts:344</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Get multiple relationships in one method</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>ids: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array of account IDs.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of Relationship.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getScheduledStatus" class="tsd-anchor"></a><h3>get<wbr/>Scheduled<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Scheduled<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#ScheduledStatus" class="tsd-signature-type" data-tsd-kind="Type alias">ScheduledStatus</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L807">src/megalodon.ts:807</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/scheduled_statuses/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target status ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#ScheduledStatus" class="tsd-signature-type" data-tsd-kind="Type alias">ScheduledStatus</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>ScheduledStatus.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getScheduledStatuses" class="tsd-anchor"></a><h3>get<wbr/>Scheduled<wbr/>Statuses</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Scheduled<wbr/>Statuses<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#ScheduledStatus" class="tsd-signature-type" data-tsd-kind="Type alias">ScheduledStatus</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L795">src/megalodon.ts:795</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/scheduled_statuses</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#ScheduledStatus" class="tsd-signature-type" data-tsd-kind="Type alias">ScheduledStatus</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of scheduled statuses.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getStatus" class="tsd-anchor"></a><h3>get<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L635">src/megalodon.ts:635</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/statuses/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getStatusContext" class="tsd-anchor"></a><h3>get<wbr/>Status<wbr/>Context</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Status<wbr/>Context<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L650">src/megalodon.ts:650</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/statuses/:id/context</p>
|
|
</div><div><p>Get parent and child statuses.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Context</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getStatusFavouritedBy" class="tsd-anchor"></a><h3>get<wbr/>Status<wbr/>Favourited<wbr/>By</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Status<wbr/>Favourited<wbr/>By<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L664">src/megalodon.ts:664</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/statuses/:id/favourited_by</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of accounts.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getStatusRebloggedBy" class="tsd-anchor"></a><h3>get<wbr/>Status<wbr/>Reblogged<wbr/>By</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Status<wbr/>Reblogged<wbr/>By<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L657">src/megalodon.ts:657</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/statuses/:id/reblogged_by</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of accounts.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getSuggestedTags" class="tsd-anchor"></a><h3>get<wbr/>Suggested<wbr/>Tags</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Suggested<wbr/>Tags<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Tag" class="tsd-signature-type" data-tsd-kind="Type alias">Tag</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L577">src/megalodon.ts:577</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/featured_tags/suggestions</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Tag" class="tsd-signature-type" data-tsd-kind="Type alias">Tag</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of tag.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getSuggestions" class="tsd-anchor"></a><h3>get<wbr/>Suggestions</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Suggestions<span class="tsd-signature-symbol">(</span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L596">src/megalodon.ts:596</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/suggestions</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Maximum number of results.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of accounts.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getTagTimeline" class="tsd-anchor"></a><h3>get<wbr/>Tag<wbr/>Timeline</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Tag<wbr/>Timeline<span class="tsd-signature-symbol">(</span>hashtag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>local<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>only_media<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L871">src/megalodon.ts:871</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/timelines/tag/:hashtag</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>hashtag: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Content of a #hashtag, not including # symbol.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>local<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>only_media<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> local<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Show only local statuses? Defaults to false.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> only_<wbr/>media<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Show only statuses with media attached? Defaults to false.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Array of statuses.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="listSocket" class="tsd-anchor"></a><h3>list<wbr/>Socket</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">list<wbr/>Socket<span class="tsd-signature-symbol">(</span>list_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WebSocketInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketInterface</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1232">src/megalodon.ts:1232</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>list_id: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="WebSocketInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketInterface</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="listStream" class="tsd-anchor"></a><h3>list<wbr/>Stream</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">list<wbr/>Stream<span class="tsd-signature-symbol">(</span>list_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="StreamListenerInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamListenerInterface</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1222">src/megalodon.ts:1222</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>list_id: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="StreamListenerInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamListenerInterface</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="localSocket" class="tsd-anchor"></a><h3>local<wbr/>Socket</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">local<wbr/>Socket<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WebSocketInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketInterface</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1230">src/megalodon.ts:1230</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="WebSocketInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketInterface</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="localStream" class="tsd-anchor"></a><h3>local<wbr/>Stream</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">local<wbr/>Stream<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="StreamListenerInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamListenerInterface</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1220">src/megalodon.ts:1220</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="StreamListenerInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamListenerInterface</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="muteAccount" class="tsd-anchor"></a><h3>mute<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">mute<wbr/>Account<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, notifications<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L309">src/megalodon.ts:309</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/accounts/:id/mute</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li><li><h5>notifications: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Mute notifications in addition to statuses.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Relationship</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="muteStatus" class="tsd-anchor"></a><h3>mute<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">mute<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L713">src/megalodon.ts:713</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/statuses/:id/mute</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="pinAccount" class="tsd-anchor"></a><h3>pin<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">pin<wbr/>Account<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L323">src/megalodon.ts:323</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/accounts/:id/pin</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Relationship</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="pinStatus" class="tsd-anchor"></a><h3>pin<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">pin<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L726">src/megalodon.ts:726</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/statuses/:id/pin</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="postStatus" class="tsd-anchor"></a><h3>post<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">post<wbr/>Status<span class="tsd-signature-symbol">(</span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>in_reply_to_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>media_ids<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>poll<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>expires_in<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hide_totals<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>multiple<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>quote_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>scheduled_at<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>sensitive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>spoiler_text<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>visibility<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"public"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"unlisted"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"private"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"direct"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L615">src/megalodon.ts:615</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/statuses</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>status: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Text content of status.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>in_reply_to_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>media_ids<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>poll<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>expires_in<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hide_totals<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>multiple<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>quote_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>scheduled_at<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>sensitive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>spoiler_text<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>visibility<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"public"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"unlisted"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"private"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"direct"</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> in_<wbr/>reply_<wbr/>to_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>ID of the status being replied to, if status is a reply.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>ISO 639 language code for this status.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> media_<wbr/>ids<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array of Attachment ids.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> poll<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>expires_in<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hide_totals<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>multiple<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Poll object.</p>
|
|
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>expires_<wbr/>in<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> hide_<wbr/>totals<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> multiple<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> quote_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>ID of the status being quoted to, if status is a quote.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> scheduled_<wbr/>at<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>ISO 8601 Datetime at which to schedule a status.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> sensitive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Mark status and attached media as sensitive?</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> spoiler_<wbr/>text<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Text to be shown as a warning or subject before the actual content.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> visibility<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"public"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"unlisted"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"private"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"direct"</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Visibility of the posted status.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="publicSocket" class="tsd-anchor"></a><h3>public<wbr/>Socket</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">public<wbr/>Socket<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WebSocketInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketInterface</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1229">src/megalodon.ts:1229</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="WebSocketInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketInterface</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="publicStream" class="tsd-anchor"></a><h3>public<wbr/>Stream</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">public<wbr/>Stream<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="StreamListenerInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamListenerInterface</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1219">src/megalodon.ts:1219</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="StreamListenerInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamListenerInterface</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="readConversation" class="tsd-anchor"></a><h3>read<wbr/>Conversation</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">read<wbr/>Conversation<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Conversation" class="tsd-signature-type" data-tsd-kind="Type alias">Conversation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L948">src/megalodon.ts:948</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/conversations/:id/read</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target conversation ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Conversation" class="tsd-signature-type" data-tsd-kind="Type alias">Conversation</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Conversation.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="reblogStatus" class="tsd-anchor"></a><h3>reblog<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">reblog<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L685">src/megalodon.ts:685</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/statuses/:id/reblog</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="refreshToken" class="tsd-anchor"></a><h3>refresh<wbr/>Token</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">refresh<wbr/>Token<span class="tsd-signature-symbol">(</span>client_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, client_secret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, refresh_token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/OAuth.TokenData.html" class="tsd-signature-type" data-tsd-kind="Class">TokenData</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L96">src/megalodon.ts:96</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /oauth/token</p>
|
|
</div><div><p>Refresh OAuth access token.
|
|
Send refresh token and get new access token.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client_id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>will be generated by #createApp or #registerApp</p>
|
|
</div></div></li><li><h5>client_secret: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>will be generated by #createApp or #registerApp</p>
|
|
</div></div></li><li><h5>refresh_token: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>will be get #fetchAccessToken</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/OAuth.TokenData.html" class="tsd-signature-type" data-tsd-kind="Class">TokenData</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="registerAccount" class="tsd-anchor"></a><h3>register<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">register<wbr/>Account<span class="tsd-signature-symbol">(</span>username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, agreement<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, locale<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Token" class="tsd-signature-type" data-tsd-kind="Type alias">Token</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L122">src/megalodon.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/accounts</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>username: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Username for the account.</p>
|
|
</div></div></li><li><h5>email: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Email for the account.</p>
|
|
</div></div></li><li><h5>password: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Password for the account.</p>
|
|
</div></div></li><li><h5>agreement: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Whether the user agrees to the local rules, terms, and policies.</p>
|
|
</div></div></li><li><h5>locale: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The language of the confirmation email that will be sent</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> reason: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Text that will be reviewed by moderators if registrations require manual approval.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Token" class="tsd-signature-type" data-tsd-kind="Type alias">Token</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>An account token.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="registerApp" class="tsd-anchor"></a><h3>register<wbr/>App</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">register<wbr/>App<span class="tsd-signature-symbol">(</span>client_name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>redirect_uris<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>scopes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>website<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/OAuth.AppData.html" class="tsd-signature-type" data-tsd-kind="Class">AppData</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L44">src/megalodon.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>First, call createApp to get client_id and client_secret.
|
|
Next, call generateAuthUrl to get authorization url.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client_name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Form Data, which is sent to /api/v1/apps</p>
|
|
</div></div></li><li><h5>options: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>redirect_uris<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>scopes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>website<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Form Data, which is sent to /api/v1/apps. and properties should be <strong>snake_case</strong></p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/OAuth.AppData.html" class="tsd-signature-type" data-tsd-kind="Class">AppData</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="rejectFollowRequest" class="tsd-anchor"></a><h3>reject<wbr/>Follow<wbr/>Request</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">reject<wbr/>Follow<wbr/>Request<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L536">src/megalodon.ts:536</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/follow_requests/:id/reject</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Relationship.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="report" class="tsd-anchor"></a><h3>report</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">report<span class="tsd-signature-symbol">(</span>account_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, comment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>forward<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>status_ids<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Report" class="tsd-signature-type" data-tsd-kind="Type alias">Report</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L512">src/megalodon.ts:512</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/reports</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>account_id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target account ID.</p>
|
|
</div></div></li><li><h5>comment: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Reason of the report.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>forward<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>status_ids<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> forward<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If the account is remote, should the report be forwarded to the remote admin?</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> status_<wbr/>ids<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array of Statuses ids to attach to the report.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Report" class="tsd-signature-type" data-tsd-kind="Type alias">Report</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Report</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="revokeToken" class="tsd-anchor"></a><h3>revoke<wbr/>Token</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">revoke<wbr/>Token<span class="tsd-signature-symbol">(</span>client_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, client_secret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L106">src/megalodon.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /oauth/revoke</p>
|
|
</div><div><p>Revoke an OAuth token.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client_id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>will be generated by #createApp or #registerApp</p>
|
|
</div></div></li><li><h5>client_secret: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>will be generated by #createApp or #registerApp</p>
|
|
</div></div></li><li><h5>token: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>will be get #fetchAccessToken</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="saveMarkers" class="tsd-anchor"></a><h3>save<wbr/>Markers</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">save<wbr/>Markers<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>home<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>last_read_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>notifications<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>last_read_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Marker" class="tsd-signature-type" data-tsd-kind="Type alias">Marker</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1035">src/megalodon.ts:1035</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/markers</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>home<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>last_read_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>notifications<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>last_read_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> home<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>last_read_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Marker position of the last read status ID in home timeline.</p>
|
|
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>last_<wbr/>read_<wbr/>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> notifications<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>last_read_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Marker position of the last read notification ID in notifications.</p>
|
|
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>last_<wbr/>read_<wbr/>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Marker" class="tsd-signature-type" data-tsd-kind="Type alias">Marker</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Marker.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="scheduleStatus" class="tsd-anchor"></a><h3>schedule<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">schedule<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scheduled_at<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#ScheduledStatus" class="tsd-signature-type" data-tsd-kind="Type alias">ScheduledStatus</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L815">src/megalodon.ts:815</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>PUT /api/v1/scheduled_statuses/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target scheduled status ID.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> scheduled_at: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>ISO 8601 Datetime at which the status will be published.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#ScheduledStatus" class="tsd-signature-type" data-tsd-kind="Type alias">ScheduledStatus</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>ScheduledStatus.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="search" class="tsd-anchor"></a><h3>search</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">search<span class="tsd-signature-symbol">(</span>q<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"accounts"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hashtags"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"statuses"</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>account_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>exclude_unreviewed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>following<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>resolve<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Results" class="tsd-signature-type" data-tsd-kind="Type alias">Results</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1135">src/megalodon.ts:1135</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v2/search</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>q: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The search query.</p>
|
|
</div></div></li><li><h5>type: <span class="tsd-signature-type">"accounts"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hashtags"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"statuses"</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Enum of search target.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>account_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>exclude_unreviewed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>following<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>min_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>resolve<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> account_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If provided, statuses returned will be authored only by this account.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> exclude_<wbr/>unreviewed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Filter out unreviewed tags? Defaults to false.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> following<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Only include accounts that the user is following. Defaults to false.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Maximum number of results to load, per type. Defaults to 20. Max 40.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than this id.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results immediately newer than this id.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> resolve<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Attempt WebFinger lookup. Defaults to false.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Results" class="tsd-signature-type" data-tsd-kind="Type alias">Results</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Results.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="searchAccount" class="tsd-anchor"></a><h3>search<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">search<wbr/>Account<span class="tsd-signature-symbol">(</span>q<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>following<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>resolve<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L354">src/megalodon.ts:354</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/accounts/search</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>q: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Search query.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>following<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>resolve<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>since_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> following<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results older than ID.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> resolve<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> since_<wbr/>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Return results newer than ID.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>The array of accounts.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="subscribeAccount" class="tsd-anchor"></a><h3>subscribe<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">subscribe<wbr/>Account<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L212">src/megalodon.ts:212</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/pleroma/accounts/:id/subscribe</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Relationship.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="subscribePushNotification" class="tsd-anchor"></a><h3>subscribe<wbr/>Push<wbr/>Notification</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">subscribe<wbr/>Push<wbr/>Notification<span class="tsd-signature-symbol">(</span>subscription<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>keys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>auth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>p256dh<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>alerts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>favourite<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>follow<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>mention<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>poll<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>reblog<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#PushSubscription" class="tsd-signature-type" data-tsd-kind="Type alias">PushSubscription</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1091">src/megalodon.ts:1091</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/push/subscription</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>subscription: <span class="tsd-signature-symbol">{ </span>endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>keys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>auth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>p256dh<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>keys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>auth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>p256dh<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>auth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>p256dh<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>alerts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>favourite<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>follow<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>mention<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>poll<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>reblog<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#PushSubscription" class="tsd-signature-type" data-tsd-kind="Type alias">PushSubscription</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>PushSubscription.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="tagSocket" class="tsd-anchor"></a><h3>tag<wbr/>Socket</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">tag<wbr/>Socket<span class="tsd-signature-symbol">(</span>tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WebSocketInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketInterface</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1231">src/megalodon.ts:1231</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>tag: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="WebSocketInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketInterface</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="tagStream" class="tsd-anchor"></a><h3>tag<wbr/>Stream</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">tag<wbr/>Stream<span class="tsd-signature-symbol">(</span>tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="StreamListenerInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamListenerInterface</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1221">src/megalodon.ts:1221</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>tag: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="StreamListenerInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamListenerInterface</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="unblockAccount" class="tsd-anchor"></a><h3>unblock<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">unblock<wbr/>Account<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L301">src/megalodon.ts:301</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/accounts/:id/unblock</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>RElationship</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="unblockDomain" class="tsd-anchor"></a><h3>unblock<wbr/>Domain</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">unblock<wbr/>Domain<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L436">src/megalodon.ts:436</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>DELETE /api/v1/domain_blocks</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>domain: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Domain to unblock</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="unbookmarkStatus" class="tsd-anchor"></a><h3>unbookmark<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">unbookmark<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L706">src/megalodon.ts:706</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/statuses/:id/unbookmark</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="unfavouriteStatus" class="tsd-anchor"></a><h3>unfavourite<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">unfavourite<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L678">src/megalodon.ts:678</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/statuses/:id/unfavourite</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="unfollowAccount" class="tsd-anchor"></a><h3>unfollow<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">unfollow<wbr/>Account<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L287">src/megalodon.ts:287</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/accounts/:id/unfollow</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Relationship</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="unmuteAccount" class="tsd-anchor"></a><h3>unmute<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">unmute<wbr/>Account<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L316">src/megalodon.ts:316</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/accounts/:id/unmute</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Relationship</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="unmuteStatus" class="tsd-anchor"></a><h3>unmute<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">unmute<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L720">src/megalodon.ts:720</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/statuses/:id/unmute</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="unpinAccount" class="tsd-anchor"></a><h3>unpin<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">unpin<wbr/>Account<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L330">src/megalodon.ts:330</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/accounts/:id/unpin</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Relationship</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="unpinStatus" class="tsd-anchor"></a><h3>unpin<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">unpin<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L733">src/megalodon.ts:733</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/statuses/:id/unpin</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="unreblogStatus" class="tsd-anchor"></a><h3>unreblog<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">unreblog<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L692">src/megalodon.ts:692</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/statuses/:id/unreblog</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The target status id.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Status" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Status.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="unsubscribeAccount" class="tsd-anchor"></a><h3>unsubscribe<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">unsubscribe<wbr/>Account<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L219">src/megalodon.ts:219</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/pleroma/accounts/:id/unsubscribe</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target account ID.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Relationship" class="tsd-signature-type" data-tsd-kind="Type alias">Relationship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Relationship.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="updateCredentials" class="tsd-anchor"></a><h3>update<wbr/>Credentials</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">update<wbr/>Credentials<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>avatar<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>bot<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>discoverable<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>display_name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fields_attributes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>header<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>locked<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>note<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>source<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>privacy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>sensitive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L141">src/megalodon.ts:141</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>PATCH /api/v1/accounts/update_credentials</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>avatar<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>bot<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>discoverable<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>display_name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fields_attributes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>header<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>locked<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>note<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>source<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>privacy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>sensitive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> avatar<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> bot<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> discoverable<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> display_<wbr/>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> fields_<wbr/>attributes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> header<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> locked<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> note<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> source<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>privacy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>sensitive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> privacy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> sensitive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>An account.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="updateFilter" class="tsd-anchor"></a><h3>update<wbr/>Filter</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">update<wbr/>Filter<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, phrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>expires_in<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>irreversible<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>whole_word<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L483">src/megalodon.ts:483</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>PUT /api/v1/filters/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The filter ID.</p>
|
|
</div></div></li><li><h5>phrase: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Text to be filtered.</p>
|
|
</div></div></li><li><h5>context: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>expires_in<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>irreversible<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>whole_word<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> expires_<wbr/>in<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>ISO 8601 Datetime for when the filter expires.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> irreversible<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Should the server irreversibly drop matching entities from home and notifications?</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> whole_<wbr/>word<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Consider word boundaries?</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Filter</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="updateList" class="tsd-anchor"></a><h3>update<wbr/>List</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">update<wbr/>List<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#List" class="tsd-signature-type" data-tsd-kind="Type alias">List</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L979">src/megalodon.ts:979</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>PUT /api/v1/lists/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target list ID.</p>
|
|
</div></div></li><li><h5>title: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>New list name.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#List" class="tsd-signature-type" data-tsd-kind="Type alias">List</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>List.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="updateMedia" class="tsd-anchor"></a><h3>update<wbr/>Media</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">update<wbr/>Media<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>file<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>focus<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>is_sensitive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Attachment" class="tsd-signature-type" data-tsd-kind="Type alias">Attachment</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L756">src/megalodon.ts:756</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>PUT /api/v1/media/:id</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target media ID.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>file<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>focus<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>is_sensitive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A plain-text description of the media.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> file<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The file to be attached, using multipart form data.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> focus<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> is_<wbr/>sensitive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Whether the media is sensitive.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Attachment" class="tsd-signature-type" data-tsd-kind="Type alias">Attachment</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Attachment</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="updatePushSubscription" class="tsd-anchor"></a><h3>update<wbr/>Push<wbr/>Subscription</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">update<wbr/>Push<wbr/>Subscription<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>alerts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>favourite<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>follow<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>mention<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>poll<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>reblog<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#PushSubscription" class="tsd-signature-type" data-tsd-kind="Type alias">PushSubscription</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1111">src/megalodon.ts:1111</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>PUT /api/v1/push/subscription</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>alerts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>favourite<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>follow<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>mention<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>poll<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>reblog<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#PushSubscription" class="tsd-signature-type" data-tsd-kind="Type alias">PushSubscription</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>PushSubscription.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="uploadMedia" class="tsd-anchor"></a><h3>upload<wbr/>Media</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">upload<wbr/>Media<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>focus<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Attachment" class="tsd-signature-type" data-tsd-kind="Type alias">Attachment</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L745">src/megalodon.ts:745</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/media</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>file: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The file to be attached, using multipart form data.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>focus<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A plain-text description of the media.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> focus<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.</p>
|
|
</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Attachment" class="tsd-signature-type" data-tsd-kind="Type alias">Attachment</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Attachment</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="userSocket" class="tsd-anchor"></a><h3>user<wbr/>Socket</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">user<wbr/>Socket<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WebSocketInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketInterface</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1228">src/megalodon.ts:1228</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="WebSocketInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketInterface</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="userStream" class="tsd-anchor"></a><h3>user<wbr/>Stream</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">user<wbr/>Stream<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="StreamListenerInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamListenerInterface</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L1218">src/megalodon.ts:1218</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="StreamListenerInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamListenerInterface</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="verifyAccountCredentials" class="tsd-anchor"></a><h3>verify<wbr/>Account<wbr/>Credentials</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">verify<wbr/>Account<wbr/>Credentials<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L135">src/megalodon.ts:135</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/accounts/verify_credentials</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Account" class="tsd-signature-type" data-tsd-kind="Type alias">Account</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Account.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="verifyAppCredentials" class="tsd-anchor"></a><h3>verify<wbr/>App<wbr/>Credentials</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">verify<wbr/>App<wbr/>Credentials<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Application" class="tsd-signature-type" data-tsd-kind="Type alias">Application</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L69">src/megalodon.ts:69</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GET /api/v1/apps/verify_credentials</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Application" class="tsd-signature-type" data-tsd-kind="Type alias">Application</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>An Application</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="votePoll" class="tsd-anchor"></a><h3>vote<wbr/>Poll</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">vote<wbr/>Poll<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, choices<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, status_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Poll" class="tsd-signature-type" data-tsd-kind="Type alias">Poll</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/53f12dd/src/megalodon.ts#L782">src/megalodon.ts:782</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>POST /api/v1/polls/:id/votes</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Target poll ID.</p>
|
|
</div></div></li><li><h5>choices: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array of own votes containing index for each option (starting from 0).</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> status_id: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Response" class="tsd-signature-type" data-tsd-kind="Type alias">Response</a><span class="tsd-signature-symbol"><</span><a href="../modules/Entity.html#Poll" class="tsd-signature-type" data-tsd-kind="Type alias">Poll</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>Poll</p>
|
|
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/Entity.html">Entity</a></li><li class=" tsd-kind-namespace"><a href="../modules/FilterContext.html">Filter<wbr/>Context</a></li><li class=" tsd-kind-namespace"><a href="../modules/NotificationType.html">Notification<wbr/>Type</a></li><li class=" tsd-kind-namespace"><a href="../modules/OAuth.html">OAuth</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="MegalodonInterface.html" class="tsd-kind-icon">Megalodon<wbr/>Interface</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#acceptFollowRequest" class="tsd-kind-icon">accept<wbr/>Follow<wbr/>Request</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#addAccountsToList" class="tsd-kind-icon">add<wbr/>Accounts<wbr/>To<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#blockAccount" class="tsd-kind-icon">block<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#blockDomain" class="tsd-kind-icon">block<wbr/>Domain</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#bookmarkStatus" class="tsd-kind-icon">bookmark<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#cancel" class="tsd-kind-icon">cancel</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#cancelScheduledStatus" class="tsd-kind-icon">cancel<wbr/>Scheduled<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#createApp" class="tsd-kind-icon">create<wbr/>App</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#createEmojiReaction" class="tsd-kind-icon">create<wbr/>Emoji<wbr/>Reaction</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#createFeaturedTag" class="tsd-kind-icon">create<wbr/>Featured<wbr/>Tag</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#createFilter" class="tsd-kind-icon">create<wbr/>Filter</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#createList" class="tsd-kind-icon">create<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteAccountsFromList" class="tsd-kind-icon">delete<wbr/>Accounts<wbr/>From<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteConversation" class="tsd-kind-icon">delete<wbr/>Conversation</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteEmojiReaction" class="tsd-kind-icon">delete<wbr/>Emoji<wbr/>Reaction</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteFeaturedTag" class="tsd-kind-icon">delete<wbr/>Featured<wbr/>Tag</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteFilter" class="tsd-kind-icon">delete<wbr/>Filter</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteList" class="tsd-kind-icon">delete<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deletePushSubscription" class="tsd-kind-icon">delete<wbr/>Push<wbr/>Subscription</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#deleteStatus" class="tsd-kind-icon">delete<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#directSocket" class="tsd-kind-icon">direct<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#directStream" class="tsd-kind-icon">direct<wbr/>Stream</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#dismissNotification" class="tsd-kind-icon">dismiss<wbr/>Notification</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#dismissNotifications" class="tsd-kind-icon">dismiss<wbr/>Notifications</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#favouriteStatus" class="tsd-kind-icon">favourite<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#fetchAccessToken" class="tsd-kind-icon">fetch<wbr/>Access<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#followAccount" class="tsd-kind-icon">follow<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccount" class="tsd-kind-icon">get<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccountFavourites" class="tsd-kind-icon">get<wbr/>Account<wbr/>Favourites</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccountFollowers" class="tsd-kind-icon">get<wbr/>Account<wbr/>Followers</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccountFollowing" class="tsd-kind-icon">get<wbr/>Account<wbr/>Following</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccountLists" class="tsd-kind-icon">get<wbr/>Account<wbr/>Lists</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccountStatuses" class="tsd-kind-icon">get<wbr/>Account<wbr/>Statuses</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getAccountsInList" class="tsd-kind-icon">get<wbr/>Accounts<wbr/>In<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getBlocks" class="tsd-kind-icon">get<wbr/>Blocks</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getBookmarks" class="tsd-kind-icon">get<wbr/>Bookmarks</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getConversationTimeline" class="tsd-kind-icon">get<wbr/>Conversation<wbr/>Timeline</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getDomainBlocks" class="tsd-kind-icon">get<wbr/>Domain<wbr/>Blocks</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getEmojiReaction" class="tsd-kind-icon">get<wbr/>Emoji<wbr/>Reaction</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getEmojiReactions" class="tsd-kind-icon">get<wbr/>Emoji<wbr/>Reactions</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getEndorsements" class="tsd-kind-icon">get<wbr/>Endorsements</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getFavourites" class="tsd-kind-icon">get<wbr/>Favourites</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getFeaturedTags" class="tsd-kind-icon">get<wbr/>Featured<wbr/>Tags</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getFilter" class="tsd-kind-icon">get<wbr/>Filter</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getFilters" class="tsd-kind-icon">get<wbr/>Filters</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getFollowRequests" class="tsd-kind-icon">get<wbr/>Follow<wbr/>Requests</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getHomeTimeline" class="tsd-kind-icon">get<wbr/>Home<wbr/>Timeline</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getIdentityProof" class="tsd-kind-icon">get<wbr/>Identity<wbr/>Proof</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getInstance" class="tsd-kind-icon">get<wbr/>Instance</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getInstanceActivity" class="tsd-kind-icon">get<wbr/>Instance<wbr/>Activity</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getInstanceCustomEmojis" class="tsd-kind-icon">get<wbr/>Instance<wbr/>Custom<wbr/>Emojis</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getInstanceDirectory" class="tsd-kind-icon">get<wbr/>Instance<wbr/>Directory</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getInstancePeers" class="tsd-kind-icon">get<wbr/>Instance<wbr/>Peers</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getInstanceTrends" class="tsd-kind-icon">get<wbr/>Instance<wbr/>Trends</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getList" class="tsd-kind-icon">get<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getListTimeline" class="tsd-kind-icon">get<wbr/>List<wbr/>Timeline</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getLists" class="tsd-kind-icon">get<wbr/>Lists</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getLocalTimeline" class="tsd-kind-icon">get<wbr/>Local<wbr/>Timeline</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getMarkers" class="tsd-kind-icon">get<wbr/>Markers</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getMutes" class="tsd-kind-icon">get<wbr/>Mutes</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getNotification" class="tsd-kind-icon">get<wbr/>Notification</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getNotifications" class="tsd-kind-icon">get<wbr/>Notifications</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getPoll" class="tsd-kind-icon">get<wbr/>Poll</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getPreferences" class="tsd-kind-icon">get<wbr/>Preferences</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getPublicTimeline" class="tsd-kind-icon">get<wbr/>Public<wbr/>Timeline</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getPushSubscription" class="tsd-kind-icon">get<wbr/>Push<wbr/>Subscription</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getRelationship" class="tsd-kind-icon">get<wbr/>Relationship</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getRelationships" class="tsd-kind-icon">get<wbr/>Relationships</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getScheduledStatus" class="tsd-kind-icon">get<wbr/>Scheduled<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getScheduledStatuses" class="tsd-kind-icon">get<wbr/>Scheduled<wbr/>Statuses</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getStatus" class="tsd-kind-icon">get<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getStatusContext" class="tsd-kind-icon">get<wbr/>Status<wbr/>Context</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getStatusFavouritedBy" class="tsd-kind-icon">get<wbr/>Status<wbr/>Favourited<wbr/>By</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getStatusRebloggedBy" class="tsd-kind-icon">get<wbr/>Status<wbr/>Reblogged<wbr/>By</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getSuggestedTags" class="tsd-kind-icon">get<wbr/>Suggested<wbr/>Tags</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getSuggestions" class="tsd-kind-icon">get<wbr/>Suggestions</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#getTagTimeline" class="tsd-kind-icon">get<wbr/>Tag<wbr/>Timeline</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#listSocket" class="tsd-kind-icon">list<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#listStream" class="tsd-kind-icon">list<wbr/>Stream</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#localSocket" class="tsd-kind-icon">local<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#localStream" class="tsd-kind-icon">local<wbr/>Stream</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#muteAccount" class="tsd-kind-icon">mute<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#muteStatus" class="tsd-kind-icon">mute<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#pinAccount" class="tsd-kind-icon">pin<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#pinStatus" class="tsd-kind-icon">pin<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#postStatus" class="tsd-kind-icon">post<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#publicSocket" class="tsd-kind-icon">public<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#publicStream" class="tsd-kind-icon">public<wbr/>Stream</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#readConversation" class="tsd-kind-icon">read<wbr/>Conversation</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#reblogStatus" class="tsd-kind-icon">reblog<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#refreshToken" class="tsd-kind-icon">refresh<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#registerAccount" class="tsd-kind-icon">register<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#registerApp" class="tsd-kind-icon">register<wbr/>App</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#rejectFollowRequest" class="tsd-kind-icon">reject<wbr/>Follow<wbr/>Request</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#report" class="tsd-kind-icon">report</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#revokeToken" class="tsd-kind-icon">revoke<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#saveMarkers" class="tsd-kind-icon">save<wbr/>Markers</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#scheduleStatus" class="tsd-kind-icon">schedule<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#search" class="tsd-kind-icon">search</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#searchAccount" class="tsd-kind-icon">search<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#subscribeAccount" class="tsd-kind-icon">subscribe<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#subscribePushNotification" class="tsd-kind-icon">subscribe<wbr/>Push<wbr/>Notification</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#tagSocket" class="tsd-kind-icon">tag<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#tagStream" class="tsd-kind-icon">tag<wbr/>Stream</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unblockAccount" class="tsd-kind-icon">unblock<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unblockDomain" class="tsd-kind-icon">unblock<wbr/>Domain</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unbookmarkStatus" class="tsd-kind-icon">unbookmark<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unfavouriteStatus" class="tsd-kind-icon">unfavourite<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unfollowAccount" class="tsd-kind-icon">unfollow<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unmuteAccount" class="tsd-kind-icon">unmute<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unmuteStatus" class="tsd-kind-icon">unmute<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unpinAccount" class="tsd-kind-icon">unpin<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unpinStatus" class="tsd-kind-icon">unpin<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unreblogStatus" class="tsd-kind-icon">unreblog<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#unsubscribeAccount" class="tsd-kind-icon">unsubscribe<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#updateCredentials" class="tsd-kind-icon">update<wbr/>Credentials</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#updateFilter" class="tsd-kind-icon">update<wbr/>Filter</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#updateList" class="tsd-kind-icon">update<wbr/>List</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#updateMedia" class="tsd-kind-icon">update<wbr/>Media</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#updatePushSubscription" class="tsd-kind-icon">update<wbr/>Push<wbr/>Subscription</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#uploadMedia" class="tsd-kind-icon">upload<wbr/>Media</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#userSocket" class="tsd-kind-icon">user<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#userStream" class="tsd-kind-icon">user<wbr/>Stream</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#verifyAccountCredentials" class="tsd-kind-icon">verify<wbr/>Account<wbr/>Credentials</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#verifyAppCredentials" class="tsd-kind-icon">verify<wbr/>App<wbr/>Credentials</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MegalodonInterface.html#votePoll" class="tsd-kind-icon">vote<wbr/>Poll</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |