Skip to content

Commit

Permalink
Update the API reference [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
cedx committed Apr 15, 2023
1 parent 7854b0f commit e7aefa4
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/404.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html><html lang="en"><!-- use theme color or fallback --><!--use textcolor from settings, otherwise create a contrasting color to theme color--><head><meta charset="utf-8"/><link href="./bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="./jquery-1.9.1.min.js"></script><script src="./bootstrap/js/bootstrap.min.js"></script><script src="./bootstrap/js/bootstrap-select.min.js"></script><link href="./styles.css" rel="stylesheet"/><link href="./extra-styles.css" rel="stylesheet"/><link href="./haxe-nav.css" rel="stylesheet"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>File not found - Free Mobile for Haxe</title></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>.navbar .brand {display: inline-block;float: none;text-shadow: 0 0 0 transparent;}</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#ffc105; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="./">Free Mobile for Haxe</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><script type="text/javascript">$(document).ready(errorSearch);</script><h1><small>404</small> Page not found</h1><p>Page not found, sorry.</p></div></div></div><footer class="section site-footer" style="background:#ffc105"><div class="container"><div class="copyright"><p style="color:#000000">This documentation is generated for version 1.1.2</p><p style="color:#000000">&copy; 2023 &nbsp;<a style="color:#000000" href="https://github.com/cedx/free-mobile.hx">https://github.com/cedx/free-mobile.hx</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
<!DOCTYPE html><html lang="en"><!-- use theme color or fallback --><!--use textcolor from settings, otherwise create a contrasting color to theme color--><head><meta charset="utf-8"/><link href="./bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="./jquery-1.9.1.min.js"></script><script src="./bootstrap/js/bootstrap.min.js"></script><script src="./bootstrap/js/bootstrap-select.min.js"></script><link href="./styles.css" rel="stylesheet"/><link href="./extra-styles.css" rel="stylesheet"/><link href="./haxe-nav.css" rel="stylesheet"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>File not found - Free Mobile for Haxe</title></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>.navbar .brand {display: inline-block;float: none;text-shadow: 0 0 0 transparent;}</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#ffc105; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="./">Free Mobile for Haxe</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><script type="text/javascript">$(document).ready(errorSearch);</script><h1><small>404</small> Page not found</h1><p>Page not found, sorry.</p></div></div></div><footer class="section site-footer" style="background:#ffc105"><div class="container"><div class="copyright"><p style="color:#000000">This documentation is generated for version 1.2.0</p><p style="color:#000000">&copy; 2023 &nbsp;<a style="color:#000000" href="https://github.com/cedx/free-mobile.hx">https://github.com/cedx/free-mobile.hx</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
2 changes: 1 addition & 1 deletion docs/free_mobile/Client.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#ffc105; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../">Free Mobile for Haxe</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><span class="viewsource"><a href="https://github.com/cedx/free-mobile.hx/blob/main/src/free_mobile/Client.hx" class="btn btn-medium"><i class="fa fa-eye"></i> View source</a></span><h1><small>class</small> Client</h1><h4><small>package <a href="../index.html">free_mobile</a></small></h4> </div><div class="body"><div class="doc doc-main"><p>Sends messages by SMS to a <a href="https://mobile.free.fr">Free Mobile</a> account.</p></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3 class="anchor"><code><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">account:<span class="type">String</span>,</span> <span style="white-space:nowrap">apiKey:<span class="type">String</span>,</span> <span style="white-space:nowrap">?baseUrl:<span class="type">Url</span></span>)</code></h3><div class="doc"><p>Creates a new client.</p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="account"></a><h3 class="anchor"><code><span class="label label-final">final</span><a href="#account"><span class="identifier">account</span></a>:<span class="type">String</span></code></h3><div class="doc"><p>The Free Mobile account.</p></div></div><div class="field "><a name="apiKey"></a><h3 class="anchor"><code><span class="label label-final">final</span><a href="#apiKey"><span class="identifier">apiKey</span></a>:<span class="type">String</span></code></h3><div class="doc"><p>The Free Mobile API key.</p></div></div><div class="field "><a name="baseUrl"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(&quot;https://smsapi.free-mobile.fr/&quot;)</span><span class="label label-final">final</span><a href="#baseUrl"><span class="identifier">baseUrl</span></a>:<span class="type">Url</span><span> = &quot;https://smsapi.free-mobile.fr/&quot;</span></code></h3><div class="doc"><p>The base URL of the remote API endpoint.</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="sendMessage"></a><h3 class="anchor"><code><a href="#sendMessage"><span class="identifier">sendMessage</span></a>(<span style="white-space:nowrap">text:<span class="type">String</span></span>):<span class="type">Promise</span>&lt;<span class="type">Noise</span>&gt;</code></h3><div class="doc"><p>Sends a SMS message to the underlying account.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#ffc105"><div class="container"><div class="copyright"><p style="color:#000000">This documentation is generated for version 1.1.2</p><p style="color:#000000">&copy; 2023 &nbsp;<a style="color:#000000" href="https://github.com/cedx/free-mobile.hx">https://github.com/cedx/free-mobile.hx</a></p></div></div></footer><script src="..//highlighter.js"></script><link href="../highlighter.css" rel="stylesheet"/></body></html>
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#ffc105; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../">Free Mobile for Haxe</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><span class="viewsource"><a href="https://github.com/cedx/free-mobile.hx/blob/main/src/free_mobile/Client.hx" class="btn btn-medium"><i class="fa fa-eye"></i> View source</a></span><h1><small>final class</small> Client</h1><h4><small>package <a href="../index.html">free_mobile</a></small></h4> </div><div class="body"><div class="doc doc-main"><p>Sends messages by SMS to a <a href="https://mobile.free.fr">Free Mobile</a> account.</p></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3 class="anchor"><code><span class="label label-meta label-meta-ignoreInstrument" title="">@:ignoreInstrument</span><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">account:<span class="type">String</span>,</span> <span style="white-space:nowrap">apiKey:<span class="type">String</span>,</span> <span style="white-space:nowrap">?baseUrl:<span class="type">Url</span></span>)</code></h3><div class="doc"><p>Creates a new client.</p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="account"></a><h3 class="anchor"><code><span class="label label-final">final</span><a href="#account"><span class="identifier">account</span></a>:<span class="type">String</span></code></h3><div class="doc"><p>The Free Mobile account.</p></div></div><div class="field "><a name="apiKey"></a><h3 class="anchor"><code><span class="label label-final">final</span><a href="#apiKey"><span class="identifier">apiKey</span></a>:<span class="type">String</span></code></h3><div class="doc"><p>The Free Mobile API key.</p></div></div><div class="field "><a name="baseUrl"></a><h3 class="anchor"><code><span class="label label-final">final</span><a href="#baseUrl"><span class="identifier">baseUrl</span></a>:<span class="type">Url</span></code></h3><div class="doc"><p>The base URL of the remote API endpoint.</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="sendMessage"></a><h3 class="anchor"><code><a href="#sendMessage"><span class="identifier">sendMessage</span></a>(<span style="white-space:nowrap">text:<span class="type">String</span></span>):<span class="type">Promise</span>&lt;<span class="type">Noise</span>&gt;</code></h3><div class="doc"><p>Sends a SMS message to the underlying account.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#ffc105"><div class="container"><div class="copyright"><p style="color:#000000">This documentation is generated for version 1.2.0</p><p style="color:#000000">&copy; 2023 &nbsp;<a style="color:#000000" href="https://github.com/cedx/free-mobile.hx">https://github.com/cedx/free-mobile.hx</a></p></div></div></footer><script src="..//highlighter.js"></script><link href="../highlighter.css" rel="stylesheet"/></body></html>
2 changes: 1 addition & 1 deletion docs/free_mobile/RemoteApi.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#ffc105; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../">Free Mobile for Haxe</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><span class="viewsource"><a href="https://github.com/cedx/free-mobile.hx/blob/main/src/free_mobile/RemoteApi.hx" class="btn btn-medium"><i class="fa fa-eye"></i> View source</a></span><h1><small>interface</small> RemoteApi</h1><h4><small>package <a href="../index.html">free_mobile</a></small></h4> </div><div class="body"><div class="doc doc-main"><p>Defines the interface of the remote API.</p></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="sendmsg"></a><h3 class="anchor"><code><span class="label label-meta label-meta-get" title="">@:get</span><a href="#sendmsg"><span class="identifier">sendmsg</span></a>(<span style="white-space:nowrap">query:{user:<span class="type">String</span>, pass:<span class="type">String</span>, msg:<span class="type">String</span>}</span>):<span class="type">Noise</span></code></h3><div class="doc"><p>Sends a SMS message to the specified Free Mobile account.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#ffc105"><div class="container"><div class="copyright"><p style="color:#000000">This documentation is generated for version 1.1.2</p><p style="color:#000000">&copy; 2023 &nbsp;<a style="color:#000000" href="https://github.com/cedx/free-mobile.hx">https://github.com/cedx/free-mobile.hx</a></p></div></div></footer><script src="..//highlighter.js"></script><link href="../highlighter.css" rel="stylesheet"/></body></html>
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#ffc105; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../">Free Mobile for Haxe</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><span class="viewsource"><a href="https://github.com/cedx/free-mobile.hx/blob/main/src/free_mobile/RemoteApi.hx" class="btn btn-medium"><i class="fa fa-eye"></i> View source</a></span><h1><small>interface</small> RemoteApi</h1><h4><small>package <a href="../index.html">free_mobile</a></small></h4> </div><div class="body"><div class="doc doc-main"><p>Defines the interface of the remote API.</p></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="sendmsg"></a><h3 class="anchor"><code><span class="label label-meta label-meta-get" title="">@:get</span><a href="#sendmsg"><span class="identifier">sendmsg</span></a>(<span style="white-space:nowrap">query:{user:<span class="type">String</span>, pass:<span class="type">String</span>, msg:<span class="type">String</span>}</span>):<span class="type">Noise</span></code></h3><div class="doc"><p>Sends a SMS message to the specified Free Mobile account.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#ffc105"><div class="container"><div class="copyright"><p style="color:#000000">This documentation is generated for version 1.2.0</p><p style="color:#000000">&copy; 2023 &nbsp;<a style="color:#000000" href="https://github.com/cedx/free-mobile.hx">https://github.com/cedx/free-mobile.hx</a></p></div></div></footer><script src="..//highlighter.js"></script><link href="../highlighter.css" rel="stylesheet"/></body></html>
Loading

0 comments on commit e7aefa4

Please sign in to comment.