5397 lines
433 KiB
HTML
5397 lines
433 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/css/main.css">
|
|
<script async src="../assets/js/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-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</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="../modules/megalodon.html">megalodon</a>
|
|
</li>
|
|
<li>
|
|
<a href="megalodon.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.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li>
|
|
<li><a href="../classes/misskey.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li>
|
|
<li><a href="../classes/pleroma.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</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="megalodon.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="megalodon.megalodoninterface.html#addaccountstolist" class="tsd-kind-icon">add<wbr>Accounts<wbr>ToList</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#blockaccount" class="tsd-kind-icon">block<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#blockdomain" class="tsd-kind-icon">block<wbr>Domain</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#bookmarkstatus" class="tsd-kind-icon">bookmark<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#cancel" class="tsd-kind-icon">cancel</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.megalodoninterface.html#createapp" class="tsd-kind-icon">create<wbr>App</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#createfilter" class="tsd-kind-icon">create<wbr>Filter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#createlist" class="tsd-kind-icon">create<wbr>List</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.megalodoninterface.html#deleteconversation" class="tsd-kind-icon">delete<wbr>Conversation</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#deletefilter" class="tsd-kind-icon">delete<wbr>Filter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#deletelist" class="tsd-kind-icon">delete<wbr>List</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.megalodoninterface.html#deletestatus" class="tsd-kind-icon">delete<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#directsocket" class="tsd-kind-icon">direct<wbr>Socket</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#directstream" class="tsd-kind-icon">direct<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#dismissnotification" class="tsd-kind-icon">dismiss<wbr>Notification</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#dismissnotifications" class="tsd-kind-icon">dismiss<wbr>Notifications</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#favouritestatus" class="tsd-kind-icon">favourite<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.megalodoninterface.html#followaccount" class="tsd-kind-icon">follow<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#getaccount" class="tsd-kind-icon">get<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.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="megalodon.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="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getaccountsinlist" class="tsd-kind-icon">get<wbr>Accounts<wbr>InList</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#getblocks" class="tsd-kind-icon">get<wbr>Blocks</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#getbookmarks" class="tsd-kind-icon">get<wbr>Bookmarks</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.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="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getendorsements" class="tsd-kind-icon">get<wbr>Endorsements</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#getfavourites" class="tsd-kind-icon">get<wbr>Favourites</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.megalodoninterface.html#getfilter" class="tsd-kind-icon">get<wbr>Filter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#getfilters" class="tsd-kind-icon">get<wbr>Filters</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getinstance" class="tsd-kind-icon">get<wbr>Instance</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.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="megalodon.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="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getlist" class="tsd-kind-icon">get<wbr>List</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.megalodoninterface.html#getlists" class="tsd-kind-icon">get<wbr>Lists</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.megalodoninterface.html#getmarkers" class="tsd-kind-icon">get<wbr>Markers</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#getmutes" class="tsd-kind-icon">get<wbr>Mutes</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#getnotification" class="tsd-kind-icon">get<wbr>Notification</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#getnotifications" class="tsd-kind-icon">get<wbr>Notifications</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#getpoll" class="tsd-kind-icon">get<wbr>Poll</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#getpreferences" class="tsd-kind-icon">get<wbr>Preferences</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getrelationship" class="tsd-kind-icon">get<wbr>Relationship</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#getrelationships" class="tsd-kind-icon">get<wbr>Relationships</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.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="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getsuggestions" class="tsd-kind-icon">get<wbr>Suggestions</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.megalodoninterface.html#listsocket" class="tsd-kind-icon">list<wbr>Socket</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#liststream" class="tsd-kind-icon">list<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#localsocket" class="tsd-kind-icon">local<wbr>Socket</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#localstream" class="tsd-kind-icon">local<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#muteaccount" class="tsd-kind-icon">mute<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#mutestatus" class="tsd-kind-icon">mute<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#pinaccount" class="tsd-kind-icon">pin<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#pinstatus" class="tsd-kind-icon">pin<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#poststatus" class="tsd-kind-icon">post<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#publicsocket" class="tsd-kind-icon">public<wbr>Socket</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#publicstream" class="tsd-kind-icon">public<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#readconversation" class="tsd-kind-icon">read<wbr>Conversation</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#reblogstatus" class="tsd-kind-icon">reblog<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#refreshtoken" class="tsd-kind-icon">refresh<wbr>Token</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#registeraccount" class="tsd-kind-icon">register<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#registerapp" class="tsd-kind-icon">register<wbr>App</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.megalodoninterface.html#report" class="tsd-kind-icon">report</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#revoketoken" class="tsd-kind-icon">revoke<wbr>Token</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#savemarkers" class="tsd-kind-icon">save<wbr>Markers</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#schedulestatus" class="tsd-kind-icon">schedule<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#search" class="tsd-kind-icon">search</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#searchaccount" class="tsd-kind-icon">search<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#subscribeaccount" class="tsd-kind-icon">subscribe<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.megalodoninterface.html#tagsocket" class="tsd-kind-icon">tag<wbr>Socket</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#tagstream" class="tsd-kind-icon">tag<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#unblockaccount" class="tsd-kind-icon">unblock<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#unblockdomain" class="tsd-kind-icon">unblock<wbr>Domain</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#unbookmarkstatus" class="tsd-kind-icon">unbookmark<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#unfavouritestatus" class="tsd-kind-icon">unfavourite<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#unfollowaccount" class="tsd-kind-icon">unfollow<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#unmuteaccount" class="tsd-kind-icon">unmute<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#unmutestatus" class="tsd-kind-icon">unmute<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#unpinaccount" class="tsd-kind-icon">unpin<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#unpinstatus" class="tsd-kind-icon">unpin<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#unreblogstatus" class="tsd-kind-icon">unreblog<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#unsubscribeaccount" class="tsd-kind-icon">unsubscribe<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#updatecredentials" class="tsd-kind-icon">update<wbr>Credentials</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#updatefilter" class="tsd-kind-icon">update<wbr>Filter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#updatelist" class="tsd-kind-icon">update<wbr>List</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#updatemedia" class="tsd-kind-icon">update<wbr>Media</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.megalodoninterface.html#uploadmedia" class="tsd-kind-icon">upload<wbr>Media</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#usersocket" class="tsd-kind-icon">user<wbr>Socket</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.megalodoninterface.html#userstream" class="tsd-kind-icon">user<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="megalodon.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="megalodon.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="megalodon.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Relationship.</p>
|
|
</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>ToList</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Accounts<wbr>ToList<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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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">
|
|
<p>Target list ID.</p>
|
|
</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">
|
|
<p>Array of account IDs to add to the list.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Relationship</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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">
|
|
<p>Domain to block.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Status.</p>
|
|
</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/f59156e/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>
|
|
<p>void</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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">
|
|
<p>Target scheduled status ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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.default.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/f59156e/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>
|
|
<p>Create an application.</p>
|
|
</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">
|
|
<p>your application's name</p>
|
|
</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">
|
|
<p>Form Data</p>
|
|
</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.default.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target hashtag name.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>FeaturedTag.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Text to be filtered.</p>
|
|
</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">
|
|
<p>Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.</p>
|
|
</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">
|
|
<p>ISO 8601 Datetime for when the filter expires.</p>
|
|
</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">
|
|
<p>Should the server irreversibly drop matching entities from home and notifications?</p>
|
|
</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">
|
|
<p>Consider word boundaries?</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Filter</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>List name.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>List.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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">
|
|
<p>Target list ID.</p>
|
|
</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">
|
|
<p>Array of account IDs to add to the list.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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">
|
|
<p>Target conversation ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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">
|
|
<p>Target featured tag id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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>
|
|
<p>Empty</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The filter ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Removed filter.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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">
|
|
<p>Target list ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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>
|
|
<p>Status</p>
|
|
</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="megalodon.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/f59156e/src/megalodon.ts#L1233">src/megalodon.ts:1233</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="megalodon.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="megalodon.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/f59156e/src/megalodon.ts#L1223">src/megalodon.ts:1223</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="megalodon.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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">
|
|
<p>Target notification ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Status.</p>
|
|
</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.default.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/f59156e/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>
|
|
<p>Fetch OAuth access token.
|
|
Get an access token based client_id and client_secret and authorization code.</p>
|
|
</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">
|
|
<p>will be generated by #createApp or #registerApp</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>client_secret: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>will be generated by #createApp or #registerApp</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>code: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>will be generated by the link of #generateAuthUrl or #registerApp</p>
|
|
</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">
|
|
<p>must be the same uri as the time when you register your OAuth application</p>
|
|
</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.default.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Relationship</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>An account.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>Target account ID.</p>
|
|
</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">
|
|
<p>Max number of results to return.</p>
|
|
</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">
|
|
<p>Return results order than ID.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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>
|
|
<p>Array of statuses.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>The array of accounts.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>The array of accounts.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>The array of lists.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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">
|
|
<p>Return statuses which exclude reblogs.</p>
|
|
</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">
|
|
<p>Return statuses which exclude replies.</p>
|
|
</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">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Show only statuses with media attached? Defaults to false.</p>
|
|
</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">
|
|
<p>Return statuses which include pinned statuses.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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>
|
|
<p>Account's statuses.</p>
|
|
</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>InList</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Accounts<wbr>InList<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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target list ID.</p>
|
|
</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">
|
|
<p>Max number of results to return.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of accounts.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of accounts.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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>
|
|
<p>Array of statuses.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of statuses.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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>
|
|
<p>Array of domain name.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of accounts.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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>
|
|
<p>Array of statuses.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of featured tag.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The filter ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Filter.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of filters.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Maximum number of results.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of account.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</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">
|
|
<p>Show only local statuses? Defaults to false.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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>
|
|
<p>Array of statuses.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of IdentityProof</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of emojis.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>How many accounts to load. Default 40.</p>
|
|
</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">
|
|
<p>Only return local accounts.</p>
|
|
</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">
|
|
<p>How many accounts to skip before returning results. Default 0.</p>
|
|
</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">
|
|
<p>Order of results.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of accounts.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Maximum number of results to return. Defaults to 10.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target list ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>List.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>Local ID of the list in the database.</p>
|
|
</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">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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>
|
|
<p>Array of statuses.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of lists.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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">
|
|
<p>Show only statuses with media attached? Defaults to false.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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>
|
|
<p>Array of statuses.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> | </span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> | </span><a href="../modules/entities_account.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>
|
|
<p>Marker or empty object.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of accounts.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target notification ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Notification.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Return only notifications received from this account.</p>
|
|
</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">
|
|
<p>Array of types to exclude.</p>
|
|
</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">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of notifications.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target poll ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Poll</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Preferences.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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">
|
|
<p>Show only statuses with media attached? Defaults to false.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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>
|
|
<p>Array of statuses.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>PushSubscription.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Relationship</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Array of account IDs.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of Relationship.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target status ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>ScheduledStatus.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of scheduled statuses.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Status</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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>
|
|
<p>Get parent and child statuses.</p>
|
|
</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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Context</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of accounts.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of accounts.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of tag.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Maximum number of results.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Array of accounts.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>Content of a #hashtag, not including # symbol.</p>
|
|
</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">
|
|
<p>Max number of results to return. Defaults to 20.</p>
|
|
</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">
|
|
<p>Show only local statuses? Defaults to false.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results immediately newer than ID.</p>
|
|
</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">
|
|
<p>Show only statuses with media attached? Defaults to false.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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>
|
|
<p>Array of statuses.</p>
|
|
</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="megalodon.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/f59156e/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="megalodon.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="megalodon.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/f59156e/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="megalodon.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="megalodon.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/f59156e/src/megalodon.ts#L1230">src/megalodon.ts:1230</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="megalodon.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="megalodon.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/f59156e/src/megalodon.ts#L1220">src/megalodon.ts:1220</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="megalodon.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>notifications: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Mute notifications in addition to statuses.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Relationship</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Status</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Relationship</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Status</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>Text content of status.</p>
|
|
</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">
|
|
<p>ID of the status being replied to, if status is a reply.</p>
|
|
</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">
|
|
<p>ISO 639 language code for this status.</p>
|
|
</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">
|
|
<p>Array of Attachment ids.</p>
|
|
</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">
|
|
<p>Poll object.</p>
|
|
</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">
|
|
<p>ID of the status being quoted to, if status is a quote.</p>
|
|
</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">
|
|
<p>ISO 8601 Datetime at which to schedule a status.</p>
|
|
</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">
|
|
<p>Mark status and attached media as sensitive?</p>
|
|
</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">
|
|
<p>Text to be shown as a warning or subject before the actual content.</p>
|
|
</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">
|
|
<p>Visibility of the posted status.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Status</p>
|
|
</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="megalodon.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/f59156e/src/megalodon.ts#L1229">src/megalodon.ts:1229</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="megalodon.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="megalodon.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/f59156e/src/megalodon.ts#L1219">src/megalodon.ts:1219</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="megalodon.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target conversation ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Conversation.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Status.</p>
|
|
</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.default.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/f59156e/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>
|
|
<p>Refresh OAuth access token.
|
|
Send refresh token and get new access token.</p>
|
|
</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">
|
|
<p>will be generated by #createApp or #registerApp</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>client_secret: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>will be generated by #createApp or #registerApp</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>refresh_token: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>will be get #fetchAccessToken</p>
|
|
</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.default.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Username for the account.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>email: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Email for the account.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>password: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Password for the account.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>agreement: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Whether the user agrees to the local rules, terms, and policies.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>locale: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The language of the confirmation email that will be sent</p>
|
|
</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">
|
|
<p>Text that will be reviewed by moderators if registrations require manual approval.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>An account token.</p>
|
|
</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.default.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/f59156e/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">
|
|
<p>Form Data, which is sent to /api/v1/apps</p>
|
|
</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">
|
|
<p>Form Data, which is sent to /api/v1/apps. and properties should be <strong>snake_case</strong></p>
|
|
</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.default.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Relationship.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target account ID.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>comment: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Reason of the report.</p>
|
|
</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">
|
|
<p>If the account is remote, should the report be forwarded to the remote admin?</p>
|
|
</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">
|
|
<p>Array of Statuses ids to attach to the report.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Report</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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>
|
|
<p>Revoke an OAuth token.</p>
|
|
</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">
|
|
<p>will be generated by #createApp or #registerApp</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>client_secret: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>will be generated by #createApp or #registerApp</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>token: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>will be get #fetchAccessToken</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Marker position of the last read status ID in home timeline.</p>
|
|
</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">
|
|
<p>Marker position of the last read notification ID in notifications.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Marker.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target scheduled status ID.</p>
|
|
</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">
|
|
<p>ISO 8601 Datetime at which the status will be published.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>ScheduledStatus.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The search query.</p>
|
|
</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">
|
|
<p>Enum of search target.</p>
|
|
</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">
|
|
<p>If provided, statuses returned will be authored only by this account.</p>
|
|
</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">
|
|
<p>Filter out unreviewed tags? Defaults to false.</p>
|
|
</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">
|
|
<p>Only include accounts that the user is following. Defaults to false.</p>
|
|
</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">
|
|
<p>Maximum number of results to load, per type. Defaults to 20. Max 40.</p>
|
|
</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">
|
|
<p>Return results older than this id.</p>
|
|
</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">
|
|
<p>Return results immediately newer than this id.</p>
|
|
</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">
|
|
<p>Attempt WebFinger lookup. Defaults to false.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Results.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Search query.</p>
|
|
</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">
|
|
<p>Max number of results to return. Defaults to 40.</p>
|
|
</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">
|
|
<p>Return results older than ID.</p>
|
|
</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">
|
|
<p>Return results newer than ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>The array of accounts.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Relationship.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>PushSubscription.</p>
|
|
</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="megalodon.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/f59156e/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="megalodon.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="megalodon.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/f59156e/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="megalodon.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>RElationship</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/f59156e/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">
|
|
<p>Domain to unblock</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Status.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Status.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Relationship</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Relationship</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Status</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Relationship</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Status</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" 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/f59156e/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">
|
|
<p>The target status id.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.entity.html#status-1" class="tsd-signature-type" data-tsd-kind="Type alias">Status</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Status.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target account ID.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Relationship.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>An account.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The filter ID.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>phrase: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Text to be filtered.</p>
|
|
</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">
|
|
<p>Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.</p>
|
|
</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">
|
|
<p>ISO 8601 Datetime for when the filter expires.</p>
|
|
</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">
|
|
<p>Should the server irreversibly drop matching entities from home and notifications?</p>
|
|
</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">
|
|
<p>Consider word boundaries?</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Filter</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target list ID.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>title: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>New list name.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>List.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target media ID.</p>
|
|
</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">
|
|
<p>A plain-text description of the media.</p>
|
|
</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">
|
|
<p>The file to be attached, using multipart form data.</p>
|
|
</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">
|
|
<p>Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.</p>
|
|
</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">
|
|
<p>Whether the media is sensitive.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Attachment</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>PushSubscription.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>The file to be attached, using multipart form data.</p>
|
|
</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">
|
|
<p>A plain-text description of the media.</p>
|
|
</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">
|
|
<p>Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Attachment</p>
|
|
</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="megalodon.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/f59156e/src/megalodon.ts#L1228">src/megalodon.ts:1228</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="megalodon.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="megalodon.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/f59156e/src/megalodon.ts#L1218">src/megalodon.ts:1218</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="megalodon.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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Account.</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>An Application</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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/f59156e/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">
|
|
<p>Target poll ID.</p>
|
|
</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">
|
|
<p>Array of own votes containing index for each option (starting from 0).</p>
|
|
</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/response.html#default" class="tsd-signature-type" data-tsd-kind="Type alias">default</a><span class="tsd-signature-symbol"><</span><a href="../modules/entities_account.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>
|
|
<p>Poll</p>
|
|
</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="current tsd-kind-module">
|
|
<a href="../modules/megalodon.html">megalodon</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/megalodon.argumenterror.html" class="tsd-kind-icon">Argument<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/megalodon.noimplementederror.html" class="tsd-kind-icon">No<wbr>Implemented<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/megalodon.unexpectederror.html" class="tsd-kind-icon">Unexpected<wbr>Error</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="megalodon.megalodoninterface.html" class="tsd-kind-icon">Megalodon<wbr>Interface</a>
|
|
<ul>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.megalodoninterface.html#addaccountstolist" class="tsd-kind-icon">add<wbr>Accounts<wbr>ToList</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#blockaccount" class="tsd-kind-icon">block<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#blockdomain" class="tsd-kind-icon">block<wbr>Domain</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#bookmarkstatus" class="tsd-kind-icon">bookmark<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#cancel" class="tsd-kind-icon">cancel</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.megalodoninterface.html#createapp" class="tsd-kind-icon">create<wbr>App</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#createfilter" class="tsd-kind-icon">create<wbr>Filter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#createlist" class="tsd-kind-icon">create<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.megalodoninterface.html#deleteconversation" class="tsd-kind-icon">delete<wbr>Conversation</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#deletefilter" class="tsd-kind-icon">delete<wbr>Filter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#deletelist" class="tsd-kind-icon">delete<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.megalodoninterface.html#deletestatus" class="tsd-kind-icon">delete<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#directsocket" class="tsd-kind-icon">direct<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#directstream" class="tsd-kind-icon">direct<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#dismissnotification" class="tsd-kind-icon">dismiss<wbr>Notification</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#dismissnotifications" class="tsd-kind-icon">dismiss<wbr>Notifications</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#favouritestatus" class="tsd-kind-icon">favourite<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.megalodoninterface.html#followaccount" class="tsd-kind-icon">follow<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#getaccount" class="tsd-kind-icon">get<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.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="megalodon.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="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getaccountsinlist" class="tsd-kind-icon">get<wbr>Accounts<wbr>InList</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#getblocks" class="tsd-kind-icon">get<wbr>Blocks</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#getbookmarks" class="tsd-kind-icon">get<wbr>Bookmarks</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.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="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getendorsements" class="tsd-kind-icon">get<wbr>Endorsements</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#getfavourites" class="tsd-kind-icon">get<wbr>Favourites</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.megalodoninterface.html#getfilter" class="tsd-kind-icon">get<wbr>Filter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#getfilters" class="tsd-kind-icon">get<wbr>Filters</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getinstance" class="tsd-kind-icon">get<wbr>Instance</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.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="megalodon.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="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getlist" class="tsd-kind-icon">get<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.megalodoninterface.html#getlists" class="tsd-kind-icon">get<wbr>Lists</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.megalodoninterface.html#getmarkers" class="tsd-kind-icon">get<wbr>Markers</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#getmutes" class="tsd-kind-icon">get<wbr>Mutes</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#getnotification" class="tsd-kind-icon">get<wbr>Notification</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#getnotifications" class="tsd-kind-icon">get<wbr>Notifications</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#getpoll" class="tsd-kind-icon">get<wbr>Poll</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#getpreferences" class="tsd-kind-icon">get<wbr>Preferences</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getrelationship" class="tsd-kind-icon">get<wbr>Relationship</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#getrelationships" class="tsd-kind-icon">get<wbr>Relationships</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.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="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#getsuggestions" class="tsd-kind-icon">get<wbr>Suggestions</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.megalodoninterface.html#listsocket" class="tsd-kind-icon">list<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#liststream" class="tsd-kind-icon">list<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#localsocket" class="tsd-kind-icon">local<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#localstream" class="tsd-kind-icon">local<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#muteaccount" class="tsd-kind-icon">mute<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#mutestatus" class="tsd-kind-icon">mute<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#pinaccount" class="tsd-kind-icon">pin<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#pinstatus" class="tsd-kind-icon">pin<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#poststatus" class="tsd-kind-icon">post<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#publicsocket" class="tsd-kind-icon">public<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#publicstream" class="tsd-kind-icon">public<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#readconversation" class="tsd-kind-icon">read<wbr>Conversation</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#reblogstatus" class="tsd-kind-icon">reblog<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#refreshtoken" class="tsd-kind-icon">refresh<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#registeraccount" class="tsd-kind-icon">register<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#registerapp" class="tsd-kind-icon">register<wbr>App</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.megalodoninterface.html#report" class="tsd-kind-icon">report</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#revoketoken" class="tsd-kind-icon">revoke<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#savemarkers" class="tsd-kind-icon">save<wbr>Markers</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#schedulestatus" class="tsd-kind-icon">schedule<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#search" class="tsd-kind-icon">search</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#searchaccount" class="tsd-kind-icon">search<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#subscribeaccount" class="tsd-kind-icon">subscribe<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.megalodoninterface.html#tagsocket" class="tsd-kind-icon">tag<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#tagstream" class="tsd-kind-icon">tag<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#unblockaccount" class="tsd-kind-icon">unblock<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#unblockdomain" class="tsd-kind-icon">unblock<wbr>Domain</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#unbookmarkstatus" class="tsd-kind-icon">unbookmark<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#unfavouritestatus" class="tsd-kind-icon">unfavourite<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#unfollowaccount" class="tsd-kind-icon">unfollow<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#unmuteaccount" class="tsd-kind-icon">unmute<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#unmutestatus" class="tsd-kind-icon">unmute<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#unpinaccount" class="tsd-kind-icon">unpin<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#unpinstatus" class="tsd-kind-icon">unpin<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#unreblogstatus" class="tsd-kind-icon">unreblog<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#unsubscribeaccount" class="tsd-kind-icon">unsubscribe<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#updatecredentials" class="tsd-kind-icon">update<wbr>Credentials</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#updatefilter" class="tsd-kind-icon">update<wbr>Filter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#updatelist" class="tsd-kind-icon">update<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#updatemedia" class="tsd-kind-icon">update<wbr>Media</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.megalodoninterface.html#uploadmedia" class="tsd-kind-icon">upload<wbr>Media</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#usersocket" class="tsd-kind-icon">user<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.megalodoninterface.html#userstream" class="tsd-kind-icon">user<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="megalodon.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="megalodon.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="megalodon.megalodoninterface.html#votepoll" class="tsd-kind-icon">vote<wbr>Poll</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="megalodon.streamlistenerinterface.html" class="tsd-kind-icon">Stream<wbr>Listener<wbr>Interface</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="megalodon.websocketinterface.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Interface</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="../modules/megalodon.html#default" class="tsd-kind-icon">default</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="../modules/megalodon.html#detector" class="tsd-kind-icon">detector</a>
|
|
</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-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
</ul>
|
|
</div>
|
|
</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/js/main.js"></script>
|
|
</body>
|
|
</html> |