This repository has been archived on 2024-10-16. You can view files and clone it, but cannot push or open issues or pull requests.
discord-dart/doc/api/index.html

141 lines
4.4 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
<meta name="generator" content="made with love by dartdoc 6.2.2">
<meta name="description" content="tn_discord API docs, for the Dart programming language.">
<title>tn_discord - Dart API docs</title>
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
<link rel="stylesheet" href="static-assets/github.css?v1">
<link rel="stylesheet" href="static-assets/styles.css?v1">
<link rel="icon" href="static-assets/favicon.png?v1">
</head>
<body data-base-href="" data-using-base-href="false" class="light-theme">
<div id="overlay-under-drawer"></div>
<header id="title">
<span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
<ol class="breadcrumbs gt-separated dark hidden-xs">
<li class="self-crumb">tn_discord package</li>
</ol>
<div class="self-name">tn_discord</div>
<form class="search navbar-right" role="search">
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
</form>
<div class="toggle" id="theme-button">
<label for="theme">
<input type="checkbox" id="theme" value="light-theme">
<span id="dark-theme-button" class="material-symbols-outlined">
brightness_4
</span>
<span id="light-theme-button" class="material-symbols-outlined">
brightness_5
</span>
</label>
</div>
</header>
<main>
<div id="dartdoc-main-content" class="main-content">
<section class="desc markdown">
<h1 id="discorddart">discord.dart</h1>
<p><a href="https://github.com/ThunderNetworkRaD/discord.dart"><img src="https://img.shields.io/pub/v/tn_discord?color=red&amp;logo=dart" alt="Pub"></a></p>
<p>This package is work in progress.</p>
<h2 id="webhooks">Webhooks</h2>
<h3 id="initializations">Initializations</h3>
<pre class="language-dart"><code class="language-dart">import 'package:tn_discord/tn_discord.dart';
main() {
const webhook = WebookClient(/*Webhook Options*/);
}
</code></pre>
<h3 id="webhook-options">Webhook Options</h3>
<ul>
<li>url: String</li>
<li>id: String</li>
<li>token: String
url overrides id and token</li>
</ul>
<h2 id="credits">Credits</h2>
<p>We took inspiration from <a href="https://github.com/discordjs/discord.js">discord.js</a> and <a href="https://github.com/BlackdestinyXX/Grapes-discord.grapes">Grapes-discord.grapes</a>.</p>
<h3 id="packages">Packages</h3>
<ul>
<li><a href="https://pub.dev/packages/http">http</a> by dart.dev (BSD-3-Clause)</li>
<li><a href="https://pub.dev/packages/events_emitter">events-emitter</a> by drafakiller.com (MIT)</li>
</ul>
</section>
<section class="summary">
<h2>Libraries</h2>
<dl>
<dt id="tn_discord">
<span class="name"><a href="tn_discord/tn_discord-library.html">tn_discord</a></span>
</dt>
<dd>
</dd>
</dl>
</section>
</div> <!-- /.main-content -->
<div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
<header id="header-search-sidebar" class="hidden-l">
<form class="search-sidebar" role="search">
<input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
</form>
</header>
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
<li class="self-crumb">tn_discord package</li>
</ol>
<h5 class="hidden-xs"><span class="package-name">tn_discord</span> <span class="package-kind">package</span></h5>
<ol>
<li class="section-title">Libraries</li>
<li><a href="tn_discord/tn_discord-library.html">tn_discord</a></li>
</ol>
</div>
<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
</div>
</main>
<footer>
<span class="no-break">
tn_discord
1.1.1
</span>
</footer>
<script src="static-assets/highlight.pack.js?v1"></script>
<script src="static-assets/docs.dart.js"></script>
</body>
</html>