5028 lines
436 KiB
HTML
5028 lines
436 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>default | 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/pleroma.html">pleroma</a>
|
|
</li>
|
|
<li>
|
|
<a href="pleroma.default.html">default</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class default</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">default</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implements</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="../interfaces/megalodon.megalodoninterface.html" class="tsd-signature-type" data-tsd-kind="Interface">MegalodonInterface</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>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="pleroma.default.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="pleroma.default.html#baseurl" class="tsd-kind-icon">base<wbr>Url</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="pleroma.default.html#client" class="tsd-kind-icon">client</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#acceptfollowrequest" class="tsd-kind-icon">accept<wbr>Follow<wbr>Request</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#addaccountstolist" class="tsd-kind-icon">add<wbr>Accounts<wbr>ToList</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#blockaccount" class="tsd-kind-icon">block<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#blockdomain" class="tsd-kind-icon">block<wbr>Domain</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#bookmarkstatus" class="tsd-kind-icon">bookmark<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#cancel" class="tsd-kind-icon">cancel</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#cancelscheduledstatus" class="tsd-kind-icon">cancel<wbr>Scheduled<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#createapp" class="tsd-kind-icon">create<wbr>App</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#createemojireaction" class="tsd-kind-icon">create<wbr>Emoji<wbr>Reaction</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#createfeaturedtag" class="tsd-kind-icon">create<wbr>Featured<wbr>Tag</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#createfilter" class="tsd-kind-icon">create<wbr>Filter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#createlist" class="tsd-kind-icon">create<wbr>List</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#deleteaccountsfromlist" class="tsd-kind-icon">delete<wbr>Accounts<wbr>From<wbr>List</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#deleteconversation" class="tsd-kind-icon">delete<wbr>Conversation</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#deleteemojireaction" class="tsd-kind-icon">delete<wbr>Emoji<wbr>Reaction</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#deletefeaturedtag" class="tsd-kind-icon">delete<wbr>Featured<wbr>Tag</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#deletefilter" class="tsd-kind-icon">delete<wbr>Filter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#deletelist" class="tsd-kind-icon">delete<wbr>List</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#deletepushsubscription" class="tsd-kind-icon">delete<wbr>Push<wbr>Subscription</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#deletestatus" class="tsd-kind-icon">delete<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#directsocket" class="tsd-kind-icon">direct<wbr>Socket</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#directstream" class="tsd-kind-icon">direct<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#dismissnotification" class="tsd-kind-icon">dismiss<wbr>Notification</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#dismissnotifications" class="tsd-kind-icon">dismiss<wbr>Notifications</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#favouritestatus" class="tsd-kind-icon">favourite<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#fetchaccesstoken" class="tsd-kind-icon">fetch<wbr>Access<wbr>Token</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#followaccount" class="tsd-kind-icon">follow<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#generateauthurl" class="tsd-kind-icon">generate<wbr>Auth<wbr>Url</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getaccount" class="tsd-kind-icon">get<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getaccountfavourites" class="tsd-kind-icon">get<wbr>Account<wbr>Favourites</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getaccountfollowers" class="tsd-kind-icon">get<wbr>Account<wbr>Followers</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getaccountfollowing" class="tsd-kind-icon">get<wbr>Account<wbr>Following</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getaccountlists" class="tsd-kind-icon">get<wbr>Account<wbr>Lists</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getaccountstatuses" class="tsd-kind-icon">get<wbr>Account<wbr>Statuses</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getaccountsinlist" class="tsd-kind-icon">get<wbr>Accounts<wbr>InList</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getblocks" class="tsd-kind-icon">get<wbr>Blocks</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getbookmarks" class="tsd-kind-icon">get<wbr>Bookmarks</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getconversationtimeline" class="tsd-kind-icon">get<wbr>Conversation<wbr>Timeline</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getdomainblocks" class="tsd-kind-icon">get<wbr>Domain<wbr>Blocks</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getemojireaction" class="tsd-kind-icon">get<wbr>Emoji<wbr>Reaction</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getemojireactions" class="tsd-kind-icon">get<wbr>Emoji<wbr>Reactions</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getendorsements" class="tsd-kind-icon">get<wbr>Endorsements</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getfavourites" class="tsd-kind-icon">get<wbr>Favourites</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getfeaturedtags" class="tsd-kind-icon">get<wbr>Featured<wbr>Tags</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getfilter" class="tsd-kind-icon">get<wbr>Filter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getfilters" class="tsd-kind-icon">get<wbr>Filters</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getfollowrequests" class="tsd-kind-icon">get<wbr>Follow<wbr>Requests</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#gethometimeline" class="tsd-kind-icon">get<wbr>Home<wbr>Timeline</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getidentityproof" class="tsd-kind-icon">get<wbr>Identity<wbr>Proof</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getinstance" class="tsd-kind-icon">get<wbr>Instance</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getinstanceactivity" class="tsd-kind-icon">get<wbr>Instance<wbr>Activity</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getinstancecustomemojis" class="tsd-kind-icon">get<wbr>Instance<wbr>Custom<wbr>Emojis</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getinstancedirectory" class="tsd-kind-icon">get<wbr>Instance<wbr>Directory</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getinstancepeers" class="tsd-kind-icon">get<wbr>Instance<wbr>Peers</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getinstancetrends" class="tsd-kind-icon">get<wbr>Instance<wbr>Trends</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getlist" class="tsd-kind-icon">get<wbr>List</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getlisttimeline" class="tsd-kind-icon">get<wbr>List<wbr>Timeline</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getlists" class="tsd-kind-icon">get<wbr>Lists</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getlocaltimeline" class="tsd-kind-icon">get<wbr>Local<wbr>Timeline</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getmarkers" class="tsd-kind-icon">get<wbr>Markers</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getmutes" class="tsd-kind-icon">get<wbr>Mutes</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getnotification" class="tsd-kind-icon">get<wbr>Notification</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getnotifications" class="tsd-kind-icon">get<wbr>Notifications</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getpoll" class="tsd-kind-icon">get<wbr>Poll</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getpreferences" class="tsd-kind-icon">get<wbr>Preferences</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getpublictimeline" class="tsd-kind-icon">get<wbr>Public<wbr>Timeline</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getpushsubscription" class="tsd-kind-icon">get<wbr>Push<wbr>Subscription</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getrelationship" class="tsd-kind-icon">get<wbr>Relationship</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getrelationships" class="tsd-kind-icon">get<wbr>Relationships</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getscheduledstatus" class="tsd-kind-icon">get<wbr>Scheduled<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getscheduledstatuses" class="tsd-kind-icon">get<wbr>Scheduled<wbr>Statuses</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getstatuscontext" class="tsd-kind-icon">get<wbr>Status<wbr>Context</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getstatusfavouritedby" class="tsd-kind-icon">get<wbr>Status<wbr>Favourited<wbr>By</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getstatusrebloggedby" class="tsd-kind-icon">get<wbr>Status<wbr>Reblogged<wbr>By</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getsuggestedtags" class="tsd-kind-icon">get<wbr>Suggested<wbr>Tags</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#getsuggestions" class="tsd-kind-icon">get<wbr>Suggestions</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#gettagtimeline" class="tsd-kind-icon">get<wbr>Tag<wbr>Timeline</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#listsocket" class="tsd-kind-icon">list<wbr>Socket</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#liststream" class="tsd-kind-icon">list<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#localsocket" class="tsd-kind-icon">local<wbr>Socket</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#localstream" class="tsd-kind-icon">local<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#muteaccount" class="tsd-kind-icon">mute<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#mutestatus" class="tsd-kind-icon">mute<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#pinaccount" class="tsd-kind-icon">pin<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#pinstatus" class="tsd-kind-icon">pin<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#poststatus" class="tsd-kind-icon">post<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#publicsocket" class="tsd-kind-icon">public<wbr>Socket</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#publicstream" class="tsd-kind-icon">public<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#readconversation" class="tsd-kind-icon">read<wbr>Conversation</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#reblogstatus" class="tsd-kind-icon">reblog<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#refreshtoken" class="tsd-kind-icon">refresh<wbr>Token</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#registeraccount" class="tsd-kind-icon">register<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#registerapp" class="tsd-kind-icon">register<wbr>App</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#rejectfollowrequest" class="tsd-kind-icon">reject<wbr>Follow<wbr>Request</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#report" class="tsd-kind-icon">report</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#revoketoken" class="tsd-kind-icon">revoke<wbr>Token</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#savemarkers" class="tsd-kind-icon">save<wbr>Markers</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#schedulestatus" class="tsd-kind-icon">schedule<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#search" class="tsd-kind-icon">search</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#searchaccount" class="tsd-kind-icon">search<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#subscribeaccount" class="tsd-kind-icon">subscribe<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#subscribepushnotification" class="tsd-kind-icon">subscribe<wbr>Push<wbr>Notification</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#tagsocket" class="tsd-kind-icon">tag<wbr>Socket</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#tagstream" class="tsd-kind-icon">tag<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#unblockaccount" class="tsd-kind-icon">unblock<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#unblockdomain" class="tsd-kind-icon">unblock<wbr>Domain</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#unbookmarkstatus" class="tsd-kind-icon">unbookmark<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#unfavouritestatus" class="tsd-kind-icon">unfavourite<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#unfollowaccount" class="tsd-kind-icon">unfollow<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#unmuteaccount" class="tsd-kind-icon">unmute<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#unmutestatus" class="tsd-kind-icon">unmute<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#unpinaccount" class="tsd-kind-icon">unpin<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#unpinstatus" class="tsd-kind-icon">unpin<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#unreblogstatus" class="tsd-kind-icon">unreblog<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#unsubscribeaccount" class="tsd-kind-icon">unsubscribe<wbr>Account</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#updatecredentials" class="tsd-kind-icon">update<wbr>Credentials</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#updatefilter" class="tsd-kind-icon">update<wbr>Filter</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#updatelist" class="tsd-kind-icon">update<wbr>List</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#updatemedia" class="tsd-kind-icon">update<wbr>Media</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#updatepushsubscription" class="tsd-kind-icon">update<wbr>Push<wbr>Subscription</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#uploadmedia" class="tsd-kind-icon">upload<wbr>Media</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#usersocket" class="tsd-kind-icon">user<wbr>Socket</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#userstream" class="tsd-kind-icon">user<wbr>Stream</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#verifyaccountcredentials" class="tsd-kind-icon">verify<wbr>Account<wbr>Credentials</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.html#verifyappcredentials" class="tsd-kind-icon">verify<wbr>App<wbr>Credentials</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pleroma.default.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>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">new default<span class="tsd-signature-symbol">(</span>baseUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<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>, userAgent<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>, proxyConfig<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><a href="../modules/proxy_config.html#proxyconfig" class="tsd-signature-type" data-tsd-kind="Type alias">ProxyConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="pleroma.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</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/pleroma.ts#L15">src/pleroma.ts:15</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>baseUrl: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>hostname or base URL</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>accessToken: <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"> = null</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>access token from OAuth2 authorization</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>userAgent: <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></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>UserAgent is specified in header on request.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>proxyConfig: <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><a href="../modules/proxy_config.html#proxyconfig" class="tsd-signature-type" data-tsd-kind="Type alias">ProxyConfig</a><span class="tsd-signature-symbol"> = false</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Proxy setting, or set false if don't use proxy.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="pleroma.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="baseurl" class="tsd-anchor"></a>
|
|
<h3>base<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">base<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L15">src/pleroma.ts:15</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="client" class="tsd-anchor"></a>
|
|
<h3>client</h3>
|
|
<div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <a href="../interfaces/pleroma_api_client.default.interface.html" class="tsd-signature-type" data-tsd-kind="Interface">Interface</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L14">src/pleroma.ts:14</a></li>
|
|
</ul>
|
|
</aside>
|
|
</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-class">
|
|
<a name="acceptfollowrequest" class="tsd-anchor"></a>
|
|
<h3>accept<wbr>Follow<wbr>Request</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#acceptfollowrequest">acceptFollowRequest</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L944">src/pleroma.ts:944</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>
|
|
</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-class">
|
|
<a name="addaccountstolist" class="tsd-anchor"></a>
|
|
<h3>add<wbr>Accounts<wbr>ToList</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#addaccountstolist">addAccountsToList</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1779">src/pleroma.ts:1779</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>
|
|
</li>
|
|
<li>
|
|
<h5>account_ids: <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><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="blockaccount" class="tsd-anchor"></a>
|
|
<h3>block<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#blockaccount">blockAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L495">src/pleroma.ts:495</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>
|
|
</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-class">
|
|
<a name="blockdomain" class="tsd-anchor"></a>
|
|
<h3>block<wbr>Domain</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#blockdomain">blockDomain</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L771">src/pleroma.ts:771</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>
|
|
</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-class">
|
|
<a name="bookmarkstatus" class="tsd-anchor"></a>
|
|
<h3>bookmark<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#bookmarkstatus">bookmarkStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1233">src/pleroma.ts:1233</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>
|
|
</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-class">
|
|
<a name="cancel" class="tsd-anchor"></a>
|
|
<h3>cancel</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#cancel">cancel</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L41">src/pleroma.ts:41</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-class">
|
|
<a name="cancelscheduledstatus" class="tsd-anchor"></a>
|
|
<h3>cancel<wbr>Scheduled<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#cancelscheduledstatus">cancelScheduledStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1421">src/pleroma.ts:1421</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>
|
|
</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-class">
|
|
<a name="createapp" class="tsd-anchor"></a>
|
|
<h3>create<wbr>App</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#createapp">createApp</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L68">src/pleroma.ts:68</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="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-class">
|
|
<a name="createemojireaction" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Emoji<wbr>Reaction</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#createemojireaction">createEmojiReaction</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2115">src/pleroma.ts:2115</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>PUT /api/v1/pleroma/statuses/:status_id/reactions/:emoji</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>
|
|
<li>
|
|
<h5>emoji: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Reaction emoji string. This string is raw unicode emoji.</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>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="createfeaturedtag" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Featured<wbr>Tag</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#createfeaturedtag">createFeaturedTag</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1000">src/pleroma.ts:1000</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>
|
|
</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-class">
|
|
<a name="createfilter" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Filter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#createfilter">createFilter</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L803">src/pleroma.ts:803</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>
|
|
</li>
|
|
<li>
|
|
<h5>context: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</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>
|
|
</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>
|
|
</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>
|
|
</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-class">
|
|
<a name="createlist" class="tsd-anchor"></a>
|
|
<h3>create<wbr>List</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#createlist">createList</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1718">src/pleroma.ts:1718</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>
|
|
</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-class">
|
|
<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-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#deleteaccountsfromlist">deleteAccountsFromList</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1785">src/pleroma.ts:1785</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>
|
|
</li>
|
|
<li>
|
|
<h5>account_ids: <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><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="deleteconversation" class="tsd-anchor"></a>
|
|
<h3>delete<wbr>Conversation</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#deleteconversation">deleteConversation</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1687">src/pleroma.ts:1687</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>
|
|
</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-class">
|
|
<a name="deleteemojireaction" class="tsd-anchor"></a>
|
|
<h3>delete<wbr>Emoji<wbr>Reaction</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#deleteemojireaction">deleteEmojiReaction</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2129">src/pleroma.ts:2129</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>DELETE /api/v1/pleroma/statuses/:status_id/reactions/:emoji</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>
|
|
<li>
|
|
<h5>emoji: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Reaction emoji string. This string is raw unicode emoji.</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>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="deletefeaturedtag" class="tsd-anchor"></a>
|
|
<h3>delete<wbr>Featured<wbr>Tag</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#deletefeaturedtag">deleteFeaturedTag</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1012">src/pleroma.ts:1012</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>
|
|
</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-class">
|
|
<a name="deletefilter" class="tsd-anchor"></a>
|
|
<h3>delete<wbr>Filter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#deletefilter">deleteFilter</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L878">src/pleroma.ts:878</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>
|
|
</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-class">
|
|
<a name="deletelist" class="tsd-anchor"></a>
|
|
<h3>delete<wbr>List</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#deletelist">deleteList</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1742">src/pleroma.ts:1742</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>
|
|
</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-class">
|
|
<a name="deletepushsubscription" class="tsd-anchor"></a>
|
|
<h3>delete<wbr>Push<wbr>Subscription</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#deletepushsubscription">deletePushSubscription</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1937">src/pleroma.ts:1937</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-class">
|
|
<a name="deletestatus" class="tsd-anchor"></a>
|
|
<h3>delete<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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><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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#deletestatus">deleteStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1148">src/pleroma.ts:1148</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>
|
|
</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-class">
|
|
<a name="directsocket" class="tsd-anchor"></a>
|
|
<h3>direct<wbr>Socket</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="pleroma_web_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#directsocket">directSocket</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2214">src/pleroma.ts:2214</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="pleroma_web_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="directstream" class="tsd-anchor"></a>
|
|
<h3>direct<wbr>Stream</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="../interfaces/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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#directstream">directStream</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2187">src/pleroma.ts:2187</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/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-class">
|
|
<a name="dismissnotification" class="tsd-anchor"></a>
|
|
<h3>dismiss<wbr>Notification</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#dismissnotification">dismissNotification</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1887">src/pleroma.ts:1887</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>
|
|
</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-class">
|
|
<a name="dismissnotifications" class="tsd-anchor"></a>
|
|
<h3>dismiss<wbr>Notifications</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#dismissnotifications">dismissNotifications</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1883">src/pleroma.ts:1883</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-class">
|
|
<a name="favouritestatus" class="tsd-anchor"></a>
|
|
<h3>favourite<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#favouritestatus">favouriteStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1201">src/pleroma.ts:1201</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>
|
|
</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-class">
|
|
<a name="fetchaccesstoken" class="tsd-anchor"></a>
|
|
<h3>fetch<wbr>Access<wbr>Token</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#fetchaccesstoken">fetchAccessToken</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L128">src/pleroma.ts:128</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>
|
|
</li>
|
|
<li>
|
|
<h5>client_secret: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>code: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>redirect_uri: <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="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-class">
|
|
<a name="followaccount" class="tsd-anchor"></a>
|
|
<h3>follow<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#followaccount">followAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L471">src/pleroma.ts:471</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>
|
|
</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-class">
|
|
<a name="generateauthurl" class="tsd-anchor"></a>
|
|
<h3>generate<wbr>Auth<wbr>Url</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">generate<wbr>Auth<wbr>Url<span class="tsd-signature-symbol">(</span>clientId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientSecret<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_uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>scope<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-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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/pleroma.ts#L99">src/pleroma.ts:99</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generate authorization url using OAuth2.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>clientId: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>your OAuth app's client ID</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>clientSecret: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>your OAuth app's client Secret</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_uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>scope<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></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>as property, redirect_uri and scope are available, and must be the same as when you register your app</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getaccount" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getaccount">getAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L275">src/pleroma.ts:275</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>
|
|
</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-class">
|
|
<a name="getaccountfavourites" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Favourites</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getaccountfavourites">getAccountFavourites</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L356">src/pleroma.ts:356</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>
|
|
</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#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-class">
|
|
<a name="getaccountfollowers" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Followers</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getaccountfollowers">getAccountFollowers</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L389">src/pleroma.ts:389</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>
|
|
</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#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-class">
|
|
<a name="getaccountfollowing" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Following</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getaccountfollowing">getAccountFollowing</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L422">src/pleroma.ts:422</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>
|
|
</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#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-class">
|
|
<a name="getaccountlists" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Lists</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getaccountlists">getAccountLists</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L455">src/pleroma.ts:455</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>
|
|
</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-class">
|
|
<a name="getaccountstatuses" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Account<wbr>Statuses</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getaccountstatuses">getAccountStatuses</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L283">src/pleroma.ts:283</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>
|
|
</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>
|
|
</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>
|
|
</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>
|
|
</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> only_<wbr>media<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> pinned<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>
|
|
</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-class">
|
|
<a name="getaccountsinlist" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Accounts<wbr>InList</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getaccountsinlist">getAccountsInList</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1746">src/pleroma.ts:1746</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>
|
|
</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#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-class">
|
|
<a name="getblocks" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Blocks</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getblocks">getBlocks</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L720">src/pleroma.ts:720</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>
|
|
</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> min_<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#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-class">
|
|
<a name="getbookmarks" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Bookmarks</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getbookmarks">getBookmarks</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L620">src/pleroma.ts:620</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>
|
|
</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> min_<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#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-class">
|
|
<a name="getconversationtimeline" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Conversation<wbr>Timeline</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getconversationtimeline">getConversationTimeline</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1651">src/pleroma.ts:1651</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>
|
|
</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> min_<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#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-class">
|
|
<a name="getdomainblocks" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Domain<wbr>Blocks</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getdomainblocks">getDomainBlocks</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L749">src/pleroma.ts:749</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>
|
|
</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> min_<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><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-class">
|
|
<a name="getemojireaction" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Emoji<wbr>Reaction</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getemojireaction">getEmojiReaction</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2156">src/pleroma.ts:2156</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>GET /api/v1/pleroma/statuses/:status_id/reactions/:emoji</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>
|
|
<li>
|
|
<h5>emoji: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Reaction emoji string. This string is url encoded unicode emoji.</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#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-class">
|
|
<a name="getemojireactions" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Emoji<wbr>Reactions</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getemojireactions">getEmojiReactions</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2142">src/pleroma.ts:2142</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>GET /api/v1/pleroma/statuses/:status_id/reactions</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#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-class">
|
|
<a name="getendorsements" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Endorsements</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getendorsements">getEndorsements</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L963">src/pleroma.ts:963</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>
|
|
</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#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-class">
|
|
<a name="getfavourites" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Favourites</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getfavourites">getFavourites</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L660">src/pleroma.ts:660</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>
|
|
</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> min_<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#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-class">
|
|
<a name="getfeaturedtags" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Featured<wbr>Tags</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getfeaturedtags">getFeaturedTags</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L992">src/pleroma.ts:992</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-class">
|
|
<a name="getfilter" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Filter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getfilter">getFilter</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L795">src/pleroma.ts:795</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>
|
|
</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-class">
|
|
<a name="getfilters" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Filters</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getfilters">getFilters</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L787">src/pleroma.ts:787</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-class">
|
|
<a name="getfollowrequests" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Follow<wbr>Requests</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getfollowrequests">getFollowRequests</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L924">src/pleroma.ts:924</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>
|
|
</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-class">
|
|
<a name="gethometimeline" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Home<wbr>Timeline</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#gethometimeline">getHomeTimeline</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1567">src/pleroma.ts:1567</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>
|
|
</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>
|
|
</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> min_<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#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-class">
|
|
<a name="getidentityproof" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Identity<wbr>Proof</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getidentityproof">getIdentityProof</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L463">src/pleroma.ts:463</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>
|
|
</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-class">
|
|
<a name="getinstance" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Instance</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getinstance">getInstance</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2014">src/pleroma.ts:2014</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-class">
|
|
<a name="getinstanceactivity" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Instance<wbr>Activity</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getinstanceactivity">getInstanceActivity</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2026">src/pleroma.ts:2026</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-class">
|
|
<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-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getinstancecustomemojis">getInstanceCustomEmojis</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2098">src/pleroma.ts:2098</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-class">
|
|
<a name="getinstancedirectory" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Instance<wbr>Directory</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getinstancedirectory">getInstanceDirectory</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2059">src/pleroma.ts:2059</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>
|
|
</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>
|
|
</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> 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>
|
|
</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-class">
|
|
<a name="getinstancepeers" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Instance<wbr>Peers</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getinstancepeers">getInstancePeers</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2022">src/pleroma.ts:2022</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-class">
|
|
<a name="getinstancetrends" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Instance<wbr>Trends</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getinstancetrends">getInstanceTrends</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2042">src/pleroma.ts:2042</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-class">
|
|
<a name="getlist" class="tsd-anchor"></a>
|
|
<h3>get<wbr>List</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getlist">getList</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1710">src/pleroma.ts:1710</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>
|
|
</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-class">
|
|
<a name="getlisttimeline" class="tsd-anchor"></a>
|
|
<h3>get<wbr>List<wbr>Timeline</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getlisttimeline">getListTimeline</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1609">src/pleroma.ts:1609</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>
|
|
</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>
|
|
</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> min_<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#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-class">
|
|
<a name="getlists" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Lists</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getlists">getLists</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1702">src/pleroma.ts:1702</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-class">
|
|
<a name="getlocaltimeline" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Local<wbr>Timeline</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getlocaltimeline">getLocalTimeline</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1472">src/pleroma.ts:1472</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>
|
|
</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> min_<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> only_<wbr>media<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>
|
|
</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-class">
|
|
<a name="getmarkers" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Markers</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getmarkers">getMarkers</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1794">src/pleroma.ts:1794</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-class">
|
|
<a name="getmutes" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Mutes</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getmutes">getMutes</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L690">src/pleroma.ts:690</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>
|
|
</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> min_<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#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-class">
|
|
<a name="getnotification" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Notification</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getnotification">getNotification</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1875">src/pleroma.ts:1875</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>
|
|
</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-class">
|
|
<a name="getnotifications" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Notifications</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getnotifications">getNotifications</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1827">src/pleroma.ts:1827</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>
|
|
</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>
|
|
</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>
|
|
</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> min_<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#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-class">
|
|
<a name="getpoll" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Poll</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getpoll">getPoll</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1340">src/pleroma.ts:1340</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>
|
|
</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-class">
|
|
<a name="getpreferences" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Preferences</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getpreferences">getPreferences</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1027">src/pleroma.ts:1027</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-class">
|
|
<a name="getpublictimeline" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Public<wbr>Timeline</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getpublictimeline">getPublicTimeline</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1428">src/pleroma.ts:1428</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>
|
|
</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> min_<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> only_<wbr>media<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>
|
|
</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-class">
|
|
<a name="getpushsubscription" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Push<wbr>Subscription</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getpushsubscription">getPushSubscription</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1913">src/pleroma.ts:1913</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-class">
|
|
<a name="getrelationship" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Relationship</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getrelationship">getRelationship</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L547">src/pleroma.ts:547</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>
|
|
</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-class">
|
|
<a name="getrelationships" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Relationships</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getrelationships">getRelationships</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L559">src/pleroma.ts:559</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>
|
|
</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-class">
|
|
<a name="getscheduledstatus" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Scheduled<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getscheduledstatus">getScheduledStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1399">src/pleroma.ts:1399</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>
|
|
</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-class">
|
|
<a name="getscheduledstatuses" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Scheduled<wbr>Statuses</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">null</span><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">null</span><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">null</span><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">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-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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getscheduledstatuses">getScheduledStatuses</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1363">src/pleroma.ts:1363</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">null</span><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">null</span><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">null</span><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">null</span><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">null</span><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">null</span><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> min_<wbr>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></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">null</span><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#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-class">
|
|
<a name="getstatus" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getstatus">getStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1140">src/pleroma.ts:1140</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>
|
|
</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-class">
|
|
<a name="getstatuscontext" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Status<wbr>Context</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getstatuscontext">getStatusContext</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1156">src/pleroma.ts:1156</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>
|
|
</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-class">
|
|
<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-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getstatusfavouritedby">getStatusFavouritedBy</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1193">src/pleroma.ts:1193</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>
|
|
</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-class">
|
|
<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-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getstatusrebloggedby">getStatusRebloggedBy</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1185">src/pleroma.ts:1185</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>
|
|
</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-class">
|
|
<a name="getsuggestedtags" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Suggested<wbr>Tags</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getsuggestedtags">getSuggestedTags</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1016">src/pleroma.ts:1016</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-class">
|
|
<a name="getsuggestions" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Suggestions</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#getsuggestions">getSuggestions</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1038">src/pleroma.ts:1038</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>
|
|
</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-class">
|
|
<a name="gettagtimeline" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Tag<wbr>Timeline</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#gettagtimeline">getTagTimeline</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1516">src/pleroma.ts:1516</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>
|
|
</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>
|
|
</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>
|
|
</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> min_<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> only_<wbr>media<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>
|
|
</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-class">
|
|
<a name="listsocket" class="tsd-anchor"></a>
|
|
<h3>list<wbr>Socket</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="pleroma_web_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#listsocket">listSocket</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2210">src/pleroma.ts:2210</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="pleroma_web_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="liststream" class="tsd-anchor"></a>
|
|
<h3>list<wbr>Stream</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="../interfaces/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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#liststream">listStream</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2183">src/pleroma.ts:2183</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="../interfaces/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-class">
|
|
<a name="localsocket" class="tsd-anchor"></a>
|
|
<h3>local<wbr>Socket</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="pleroma_web_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#localsocket">localSocket</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2202">src/pleroma.ts:2202</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="pleroma_web_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="localstream" class="tsd-anchor"></a>
|
|
<h3>local<wbr>Stream</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="../interfaces/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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#localstream">localStream</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2175">src/pleroma.ts:2175</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/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-class">
|
|
<a name="muteaccount" class="tsd-anchor"></a>
|
|
<h3>mute<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#muteaccount">muteAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L511">src/pleroma.ts:511</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>
|
|
</li>
|
|
<li>
|
|
<h5>notifications: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</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#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-class">
|
|
<a name="mutestatus" class="tsd-anchor"></a>
|
|
<h3>mute<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#mutestatus">muteStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1249">src/pleroma.ts:1249</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>
|
|
</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-class">
|
|
<a name="pinaccount" class="tsd-anchor"></a>
|
|
<h3>pin<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#pinaccount">pinAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L531">src/pleroma.ts:531</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>
|
|
</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-class">
|
|
<a name="pinstatus" class="tsd-anchor"></a>
|
|
<h3>pin<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#pinstatus">pinStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1265">src/pleroma.ts:1265</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>
|
|
</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-class">
|
|
<a name="poststatus" class="tsd-anchor"></a>
|
|
<h3>post<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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>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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#poststatus">postStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1061">src/pleroma.ts:1061</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>
|
|
</li>
|
|
<li>
|
|
<h5>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>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>
|
|
</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>
|
|
</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>
|
|
</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>
|
|
<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> scheduled_<wbr>at<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>
|
|
<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>
|
|
</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>
|
|
</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-class">
|
|
<a name="publicsocket" class="tsd-anchor"></a>
|
|
<h3>public<wbr>Socket</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="pleroma_web_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#publicsocket">publicSocket</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2198">src/pleroma.ts:2198</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="pleroma_web_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="publicstream" class="tsd-anchor"></a>
|
|
<h3>public<wbr>Stream</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="../interfaces/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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#publicstream">publicStream</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2171">src/pleroma.ts:2171</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/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-class">
|
|
<a name="readconversation" class="tsd-anchor"></a>
|
|
<h3>read<wbr>Conversation</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#readconversation">readConversation</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1691">src/pleroma.ts:1691</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>
|
|
</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-class">
|
|
<a name="reblogstatus" class="tsd-anchor"></a>
|
|
<h3>reblog<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#reblogstatus">reblogStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1217">src/pleroma.ts:1217</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>
|
|
</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-class">
|
|
<a name="refreshtoken" class="tsd-anchor"></a>
|
|
<h3>refresh<wbr>Token</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#refreshtoken">refreshToken</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L148">src/pleroma.ts:148</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>
|
|
</li>
|
|
<li>
|
|
<h5>client_secret: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>refresh_token: <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="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-class">
|
|
<a name="registeraccount" class="tsd-anchor"></a>
|
|
<h3>register<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#registeraccount">registerAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L170">src/pleroma.ts:170</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>
|
|
</li>
|
|
<li>
|
|
<h5>email: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>password: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>agreement: <span class="tsd-signature-type">boolean</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>locale: <span class="tsd-signature-type">string</span></h5>
|
|
</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>
|
|
</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-class">
|
|
<a name="registerapp" class="tsd-anchor"></a>
|
|
<h3>register<wbr>App</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#registerapp">registerApp</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L45">src/pleroma.ts:45</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>
|
|
</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>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="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-class">
|
|
<a name="rejectfollowrequest" class="tsd-anchor"></a>
|
|
<h3>reject<wbr>Follow<wbr>Request</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#rejectfollowrequest">rejectFollowRequest</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L952">src/pleroma.ts:952</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>
|
|
</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-class">
|
|
<a name="report" class="tsd-anchor"></a>
|
|
<h3>report</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#report">report</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L889">src/pleroma.ts:889</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>
|
|
</li>
|
|
<li>
|
|
<h5>comment: <span class="tsd-signature-type">string</span></h5>
|
|
</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>
|
|
</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>
|
|
</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-class">
|
|
<a name="revoketoken" class="tsd-anchor"></a>
|
|
<h3>revoke<wbr>Token</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#revoketoken">revokeToken</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L159">src/pleroma.ts:159</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>
|
|
</li>
|
|
<li>
|
|
<h5>client_secret: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>token: <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><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-class">
|
|
<a name="savemarkers" class="tsd-anchor"></a>
|
|
<h3>save<wbr>Markers</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#savemarkers">saveMarkers</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1800">src/pleroma.ts:1800</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>
|
|
<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>
|
|
<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-class">
|
|
<a name="schedulestatus" class="tsd-anchor"></a>
|
|
<h3>schedule<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#schedulestatus">scheduleStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1407">src/pleroma.ts:1407</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>
|
|
</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>
|
|
</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-class">
|
|
<a name="search" class="tsd-anchor"></a>
|
|
<h3>search</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#search">search</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1944">src/pleroma.ts:1944</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>
|
|
</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>
|
|
</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>
|
|
</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>
|
|
</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>
|
|
</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>
|
|
</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> min_<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> 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>
|
|
</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-class">
|
|
<a name="searchaccount" class="tsd-anchor"></a>
|
|
<h3>search<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#searchaccount">searchAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L571">src/pleroma.ts:571</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>
|
|
</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>
|
|
</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> 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>
|
|
</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-class">
|
|
<a name="subscribeaccount" class="tsd-anchor"></a>
|
|
<h3>subscribe<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#subscribeaccount">subscribeAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L340">src/pleroma.ts:340</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>
|
|
</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-class">
|
|
<a name="subscribepushnotification" class="tsd-anchor"></a>
|
|
<h3>subscribe<wbr>Push<wbr>Notification</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#subscribepushnotification">subscribePushNotification</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1894">src/pleroma.ts:1894</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-class">
|
|
<a name="tagsocket" class="tsd-anchor"></a>
|
|
<h3>tag<wbr>Socket</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="pleroma_web_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#tagsocket">tagSocket</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2206">src/pleroma.ts:2206</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="pleroma_web_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="tagstream" class="tsd-anchor"></a>
|
|
<h3>tag<wbr>Stream</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="../interfaces/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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#tagstream">tagStream</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2179">src/pleroma.ts:2179</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="../interfaces/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-class">
|
|
<a name="unblockaccount" class="tsd-anchor"></a>
|
|
<h3>unblock<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#unblockaccount">unblockAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L503">src/pleroma.ts:503</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>
|
|
</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-class">
|
|
<a name="unblockdomain" class="tsd-anchor"></a>
|
|
<h3>unblock<wbr>Domain</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#unblockdomain">unblockDomain</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L777">src/pleroma.ts:777</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>
|
|
</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-class">
|
|
<a name="unbookmarkstatus" class="tsd-anchor"></a>
|
|
<h3>unbookmark<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#unbookmarkstatus">unbookmarkStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1241">src/pleroma.ts:1241</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>
|
|
</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-class">
|
|
<a name="unfavouritestatus" class="tsd-anchor"></a>
|
|
<h3>unfavourite<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#unfavouritestatus">unfavouriteStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1209">src/pleroma.ts:1209</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>
|
|
</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-class">
|
|
<a name="unfollowaccount" class="tsd-anchor"></a>
|
|
<h3>unfollow<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#unfollowaccount">unfollowAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L487">src/pleroma.ts:487</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>
|
|
</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-class">
|
|
<a name="unmuteaccount" class="tsd-anchor"></a>
|
|
<h3>unmute<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#unmuteaccount">unmuteAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L523">src/pleroma.ts:523</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>
|
|
</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-class">
|
|
<a name="unmutestatus" class="tsd-anchor"></a>
|
|
<h3>unmute<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#unmutestatus">unmuteStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1257">src/pleroma.ts:1257</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>
|
|
</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-class">
|
|
<a name="unpinaccount" class="tsd-anchor"></a>
|
|
<h3>unpin<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#unpinaccount">unpinAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L539">src/pleroma.ts:539</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>
|
|
</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-class">
|
|
<a name="unpinstatus" class="tsd-anchor"></a>
|
|
<h3>unpin<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#unpinstatus">unpinStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1273">src/pleroma.ts:1273</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>
|
|
</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-class">
|
|
<a name="unreblogstatus" class="tsd-anchor"></a>
|
|
<h3>unreblog<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#unreblogstatus">unreblogStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1225">src/pleroma.ts:1225</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>
|
|
</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-class">
|
|
<a name="unsubscribeaccount" class="tsd-anchor"></a>
|
|
<h3>unsubscribe<wbr>Account</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#unsubscribeaccount">unsubscribeAccount</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L348">src/pleroma.ts:348</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>
|
|
</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-class">
|
|
<a name="updatecredentials" class="tsd-anchor"></a>
|
|
<h3>update<wbr>Credentials</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#updatecredentials">updateCredentials</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L205">src/pleroma.ts:205</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-class">
|
|
<a name="updatefilter" class="tsd-anchor"></a>
|
|
<h3>update<wbr>Filter</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#updatefilter">updateFilter</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L840">src/pleroma.ts:840</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>
|
|
</li>
|
|
<li>
|
|
<h5>phrase: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>context: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</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>
|
|
</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>
|
|
</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>
|
|
</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-class">
|
|
<a name="updatelist" class="tsd-anchor"></a>
|
|
<h3>update<wbr>List</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#updatelist">updateList</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1730">src/pleroma.ts:1730</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>
|
|
</li>
|
|
<li>
|
|
<h5>title: <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#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-class">
|
|
<a name="updatemedia" class="tsd-anchor"></a>
|
|
<h3>update<wbr>Media</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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><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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#updatemedia">updateMedia</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1306">src/pleroma.ts:1306</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>
|
|
</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></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>
|
|
</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>
|
|
</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>
|
|
</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-class">
|
|
<a name="updatepushsubscription" class="tsd-anchor"></a>
|
|
<h3>update<wbr>Push<wbr>Subscription</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#updatepushsubscription">updatePushSubscription</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1921">src/pleroma.ts:1921</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-class">
|
|
<a name="uploadmedia" class="tsd-anchor"></a>
|
|
<h3>upload<wbr>Media</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#uploadmedia">uploadMedia</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1284">src/pleroma.ts:1284</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>
|
|
</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>
|
|
</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>
|
|
</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-class">
|
|
<a name="usersocket" class="tsd-anchor"></a>
|
|
<h3>user<wbr>Socket</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="pleroma_web_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#usersocket">userSocket</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2194">src/pleroma.ts:2194</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="pleroma_web_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="userstream" class="tsd-anchor"></a>
|
|
<h3>user<wbr>Stream</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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="../interfaces/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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#userstream">userStream</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L2167">src/pleroma.ts:2167</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/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-class">
|
|
<a name="verifyaccountcredentials" class="tsd-anchor"></a>
|
|
<h3>verify<wbr>Account<wbr>Credentials</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#verifyaccountcredentials">verifyAccountCredentials</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L197">src/pleroma.ts:197</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-class">
|
|
<a name="verifyappcredentials" class="tsd-anchor"></a>
|
|
<h3>verify<wbr>App<wbr>Credentials</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#verifyappcredentials">verifyAppCredentials</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L121">src/pleroma.ts:121</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-class">
|
|
<a name="votepoll" class="tsd-anchor"></a>
|
|
<h3>vote<wbr>Poll</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<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><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">
|
|
<p>Implementation of <a href="../interfaces/megalodon.megalodoninterface.html">MegalodonInterface</a>.<a href="../interfaces/megalodon.megalodoninterface.html#votepoll">votePoll</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/h3poteto/megalodon/blob/f59156e/src/pleroma.ts#L1348">src/pleroma.ts:1348</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>
|
|
</li>
|
|
<li>
|
|
<h5>choices: <span class="tsd-signature-type">number</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#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/pleroma.html">pleroma</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
<a href="pleroma.default.html" class="tsd-kind-icon">default</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#baseurl" class="tsd-kind-icon">base<wbr>Url</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#client" class="tsd-kind-icon">client</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#acceptfollowrequest" class="tsd-kind-icon">accept<wbr>Follow<wbr>Request</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#addaccountstolist" class="tsd-kind-icon">add<wbr>Accounts<wbr>ToList</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#blockaccount" class="tsd-kind-icon">block<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#blockdomain" class="tsd-kind-icon">block<wbr>Domain</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#bookmarkstatus" class="tsd-kind-icon">bookmark<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#cancel" class="tsd-kind-icon">cancel</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#cancelscheduledstatus" class="tsd-kind-icon">cancel<wbr>Scheduled<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#createapp" class="tsd-kind-icon">create<wbr>App</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#createemojireaction" class="tsd-kind-icon">create<wbr>Emoji<wbr>Reaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#createfeaturedtag" class="tsd-kind-icon">create<wbr>Featured<wbr>Tag</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#createfilter" class="tsd-kind-icon">create<wbr>Filter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#createlist" class="tsd-kind-icon">create<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#deleteaccountsfromlist" class="tsd-kind-icon">delete<wbr>Accounts<wbr>From<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#deleteconversation" class="tsd-kind-icon">delete<wbr>Conversation</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#deleteemojireaction" class="tsd-kind-icon">delete<wbr>Emoji<wbr>Reaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#deletefeaturedtag" class="tsd-kind-icon">delete<wbr>Featured<wbr>Tag</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#deletefilter" class="tsd-kind-icon">delete<wbr>Filter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#deletelist" class="tsd-kind-icon">delete<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#deletepushsubscription" class="tsd-kind-icon">delete<wbr>Push<wbr>Subscription</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#deletestatus" class="tsd-kind-icon">delete<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#directsocket" class="tsd-kind-icon">direct<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#directstream" class="tsd-kind-icon">direct<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#dismissnotification" class="tsd-kind-icon">dismiss<wbr>Notification</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#dismissnotifications" class="tsd-kind-icon">dismiss<wbr>Notifications</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#favouritestatus" class="tsd-kind-icon">favourite<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#fetchaccesstoken" class="tsd-kind-icon">fetch<wbr>Access<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#followaccount" class="tsd-kind-icon">follow<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#generateauthurl" class="tsd-kind-icon">generate<wbr>Auth<wbr>Url</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getaccount" class="tsd-kind-icon">get<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getaccountfavourites" class="tsd-kind-icon">get<wbr>Account<wbr>Favourites</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getaccountfollowers" class="tsd-kind-icon">get<wbr>Account<wbr>Followers</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getaccountfollowing" class="tsd-kind-icon">get<wbr>Account<wbr>Following</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getaccountlists" class="tsd-kind-icon">get<wbr>Account<wbr>Lists</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getaccountstatuses" class="tsd-kind-icon">get<wbr>Account<wbr>Statuses</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getaccountsinlist" class="tsd-kind-icon">get<wbr>Accounts<wbr>InList</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getblocks" class="tsd-kind-icon">get<wbr>Blocks</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getbookmarks" class="tsd-kind-icon">get<wbr>Bookmarks</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getconversationtimeline" class="tsd-kind-icon">get<wbr>Conversation<wbr>Timeline</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getdomainblocks" class="tsd-kind-icon">get<wbr>Domain<wbr>Blocks</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getemojireaction" class="tsd-kind-icon">get<wbr>Emoji<wbr>Reaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getemojireactions" class="tsd-kind-icon">get<wbr>Emoji<wbr>Reactions</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getendorsements" class="tsd-kind-icon">get<wbr>Endorsements</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getfavourites" class="tsd-kind-icon">get<wbr>Favourites</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getfeaturedtags" class="tsd-kind-icon">get<wbr>Featured<wbr>Tags</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getfilter" class="tsd-kind-icon">get<wbr>Filter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getfilters" class="tsd-kind-icon">get<wbr>Filters</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getfollowrequests" class="tsd-kind-icon">get<wbr>Follow<wbr>Requests</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#gethometimeline" class="tsd-kind-icon">get<wbr>Home<wbr>Timeline</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getidentityproof" class="tsd-kind-icon">get<wbr>Identity<wbr>Proof</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getinstance" class="tsd-kind-icon">get<wbr>Instance</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getinstanceactivity" class="tsd-kind-icon">get<wbr>Instance<wbr>Activity</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getinstancecustomemojis" class="tsd-kind-icon">get<wbr>Instance<wbr>Custom<wbr>Emojis</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getinstancedirectory" class="tsd-kind-icon">get<wbr>Instance<wbr>Directory</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getinstancepeers" class="tsd-kind-icon">get<wbr>Instance<wbr>Peers</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getinstancetrends" class="tsd-kind-icon">get<wbr>Instance<wbr>Trends</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getlist" class="tsd-kind-icon">get<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getlisttimeline" class="tsd-kind-icon">get<wbr>List<wbr>Timeline</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getlists" class="tsd-kind-icon">get<wbr>Lists</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getlocaltimeline" class="tsd-kind-icon">get<wbr>Local<wbr>Timeline</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getmarkers" class="tsd-kind-icon">get<wbr>Markers</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getmutes" class="tsd-kind-icon">get<wbr>Mutes</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getnotification" class="tsd-kind-icon">get<wbr>Notification</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getnotifications" class="tsd-kind-icon">get<wbr>Notifications</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getpoll" class="tsd-kind-icon">get<wbr>Poll</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getpreferences" class="tsd-kind-icon">get<wbr>Preferences</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getpublictimeline" class="tsd-kind-icon">get<wbr>Public<wbr>Timeline</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getpushsubscription" class="tsd-kind-icon">get<wbr>Push<wbr>Subscription</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getrelationship" class="tsd-kind-icon">get<wbr>Relationship</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getrelationships" class="tsd-kind-icon">get<wbr>Relationships</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getscheduledstatus" class="tsd-kind-icon">get<wbr>Scheduled<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getscheduledstatuses" class="tsd-kind-icon">get<wbr>Scheduled<wbr>Statuses</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getstatuscontext" class="tsd-kind-icon">get<wbr>Status<wbr>Context</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getstatusfavouritedby" class="tsd-kind-icon">get<wbr>Status<wbr>Favourited<wbr>By</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getstatusrebloggedby" class="tsd-kind-icon">get<wbr>Status<wbr>Reblogged<wbr>By</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getsuggestedtags" class="tsd-kind-icon">get<wbr>Suggested<wbr>Tags</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#getsuggestions" class="tsd-kind-icon">get<wbr>Suggestions</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#gettagtimeline" class="tsd-kind-icon">get<wbr>Tag<wbr>Timeline</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#listsocket" class="tsd-kind-icon">list<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#liststream" class="tsd-kind-icon">list<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#localsocket" class="tsd-kind-icon">local<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#localstream" class="tsd-kind-icon">local<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#muteaccount" class="tsd-kind-icon">mute<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#mutestatus" class="tsd-kind-icon">mute<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#pinaccount" class="tsd-kind-icon">pin<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#pinstatus" class="tsd-kind-icon">pin<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#poststatus" class="tsd-kind-icon">post<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#publicsocket" class="tsd-kind-icon">public<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#publicstream" class="tsd-kind-icon">public<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#readconversation" class="tsd-kind-icon">read<wbr>Conversation</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#reblogstatus" class="tsd-kind-icon">reblog<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#refreshtoken" class="tsd-kind-icon">refresh<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#registeraccount" class="tsd-kind-icon">register<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#registerapp" class="tsd-kind-icon">register<wbr>App</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#rejectfollowrequest" class="tsd-kind-icon">reject<wbr>Follow<wbr>Request</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#report" class="tsd-kind-icon">report</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#revoketoken" class="tsd-kind-icon">revoke<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#savemarkers" class="tsd-kind-icon">save<wbr>Markers</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#schedulestatus" class="tsd-kind-icon">schedule<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#search" class="tsd-kind-icon">search</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#searchaccount" class="tsd-kind-icon">search<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#subscribeaccount" class="tsd-kind-icon">subscribe<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#subscribepushnotification" class="tsd-kind-icon">subscribe<wbr>Push<wbr>Notification</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#tagsocket" class="tsd-kind-icon">tag<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#tagstream" class="tsd-kind-icon">tag<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#unblockaccount" class="tsd-kind-icon">unblock<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#unblockdomain" class="tsd-kind-icon">unblock<wbr>Domain</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#unbookmarkstatus" class="tsd-kind-icon">unbookmark<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#unfavouritestatus" class="tsd-kind-icon">unfavourite<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#unfollowaccount" class="tsd-kind-icon">unfollow<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#unmuteaccount" class="tsd-kind-icon">unmute<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#unmutestatus" class="tsd-kind-icon">unmute<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#unpinaccount" class="tsd-kind-icon">unpin<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#unpinstatus" class="tsd-kind-icon">unpin<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#unreblogstatus" class="tsd-kind-icon">unreblog<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#unsubscribeaccount" class="tsd-kind-icon">unsubscribe<wbr>Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#updatecredentials" class="tsd-kind-icon">update<wbr>Credentials</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#updatefilter" class="tsd-kind-icon">update<wbr>Filter</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#updatelist" class="tsd-kind-icon">update<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#updatemedia" class="tsd-kind-icon">update<wbr>Media</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#updatepushsubscription" class="tsd-kind-icon">update<wbr>Push<wbr>Subscription</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#uploadmedia" class="tsd-kind-icon">upload<wbr>Media</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#usersocket" class="tsd-kind-icon">user<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#userstream" class="tsd-kind-icon">user<wbr>Stream</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#verifyaccountcredentials" class="tsd-kind-icon">verify<wbr>Account<wbr>Credentials</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#verifyappcredentials" class="tsd-kind-icon">verify<wbr>App<wbr>Credentials</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pleroma.default.html#votepoll" class="tsd-kind-icon">vote<wbr>Poll</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</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-class"><span class="tsd-kind-icon">Class</span></li>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</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> |