<!DOCTYPE HTML> <!-- NewPage --> <html lang="it"> <head> <!-- Generated by javadoc (10.0.1) on Wed Jul 18 17:15:47 CEST 2018 --> <title>EasyClient</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="dc.created" content="2018-07-18"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style"> <script type="text/javascript" src="../../../script.js"></script> <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script> <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> <!--[if IE]> <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> <![endif]--> <script type="text/javascript" src="../../../jquery/jquery-1.10.2.js"></script> <script type="text/javascript" src="../../../jquery/jquery-ui.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="EasyClient"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; var pathtoroot = "../../../";loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <header role="banner"> <nav role="navigation"> <div class="fixedNav"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a id="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../it/ernytech/tdbot/ConstructorDetector.html" title="class in it.ernytech.tdbot"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../it/ernytech/tdbot/UserClient.html" title="class in it.ernytech.tdbot"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?it/ernytech/tdbot/EasyClient.html" target="_top">Frames</a></li> <li><a href="EasyClient.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <ul class="navListSearch"> <li><label for="search">SEARCH:</label> <input type="text" id="search" value="search" disabled="disabled"> <input type="reset" id="reset" value="reset" disabled="disabled"> </li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a id="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> </div> <div class="navPadding"> </div> <script type="text/javascript"><!-- $('.navPadding').css('padding-top', $('.fixedNav').css("height")); //--> </script> </nav> </header> <!-- ======== START OF CLASS DATA ======== --> <main role="main"> <div class="header"> <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="../../../it/ernytech/tdbot/package-summary.html">it.ernytech.tdbot</a></div> <h2 title="Class EasyClient" class="title">Class EasyClient</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>it.ernytech.tdbot.EasyClient</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>Direct Known Subclasses:</dt> <dd><code><a href="../../../it/ernytech/tdbot/BotClient.html" title="class in it.ernytech.tdbot">BotClient</a></code>, <code><a href="../../../it/ernytech/tdbot/UserClient.html" title="class in it.ernytech.tdbot">UserClient</a></code></dd> </dl> <hr> <pre>public class <span class="typeNameLabel">EasyClient</span> extends java.lang.Object</pre> <div class="block">Interface for easy interaction with TDLib for bot, used to implement other clients such as BotClient and UserClient.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="field.summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="memberSummary"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Field</th> <th class="colLast" scope="col">Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected boolean</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdbot/EasyClient.html#haveAuthorization">haveAuthorization</a></span></code></th> <td class="colLast"> </td> </tr> </table> </li> </ul> </section> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="memberSummary"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier</th> <th class="colSecond" scope="col">Constructor</th> <th class="colLast" scope="col">Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected </code></td> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdbot/EasyClient.html#%3Cinit%3E(it.ernytech.tdbot.AuthorizationHandler)">EasyClient</a></span>​(<a href="../../../it/ernytech/tdbot/AuthorizationHandler.html" title="interface in it.ernytech.tdbot">AuthorizationHandler</a> authorizationHandler)</code></th> <td class="colLast"> <div class="block">Creates a new EasyClient.</div> </td> </tr> </table> </li> </ul> </section> <!-- ========== METHOD SUMMARY =========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Method</th> <th class="colLast" scope="col">Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>protected void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdbot/EasyClient.html#authorizationHandler(it.ernytech.tdlib.TdApi.UpdateAuthorizationState)">authorizationHandler</a></span>​(<a href="../../../it/ernytech/tdlib/TdApi.UpdateAuthorizationState.html" title="class in it.ernytech.tdlib">TdApi.UpdateAuthorizationState</a> authorizationState)</code></th> <td class="colLast"> <div class="block">Manages the authorization state updates.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>protected void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdbot/EasyClient.html#destroyBotClient()">destroyBotClient</a></span>()</code></th> <td class="colLast"> <div class="block">Destroys the client and TDLib instance.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>protected <a href="../../../it/ernytech/tdlib/Response.html" title="class in it.ernytech.tdlib">Response</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdbot/EasyClient.html#execute(it.ernytech.tdlib.TdApi.Function)">execute</a></span>​(<a href="../../../it/ernytech/tdlib/TdApi.Function.html" title="class in it.ernytech.tdlib">TdApi.Function</a> function)</code></th> <td class="colLast"> <div class="block">Send a request to tdlib, wait for the result and return the response.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>protected void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdbot/EasyClient.html#execute(it.ernytech.tdlib.TdApi.Function,it.ernytech.tdlib.utils.ReceiveCallback,it.ernytech.tdlib.utils.ErrorCallback)">execute</a></span>​(<a href="../../../it/ernytech/tdlib/TdApi.Function.html" title="class in it.ernytech.tdlib">TdApi.Function</a> function, <a href="../../../it/ernytech/tdlib/utils/ReceiveCallback.html" title="interface in it.ernytech.tdlib.utils">ReceiveCallback</a> receiveCallback, <a href="../../../it/ernytech/tdlib/utils/ErrorCallback.html" title="interface in it.ernytech.tdlib.utils">ErrorCallback</a> errorCallback)</code></th> <td class="colLast"> <div class="block">Send a request to tdlib and send the response to the callbacks.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>protected long</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdbot/EasyClient.html#send(it.ernytech.tdlib.TdApi.Function)">send</a></span>​(<a href="../../../it/ernytech/tdlib/TdApi.Function.html" title="class in it.ernytech.tdlib">TdApi.Function</a> function)</code></th> <td class="colLast"> <div class="block">Send a request to tdlib without waiting for the result.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>protected void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdbot/EasyClient.html#setCloseCallback(it.ernytech.tdlib.utils.CloseCallback)">setCloseCallback</a></span>​(<a href="../../../it/ernytech/tdlib/utils/CloseCallback.html" title="interface in it.ernytech.tdlib.utils">CloseCallback</a> closeCallback)</code></th> <td class="colLast"> <div class="block">Set the default callback for Tdlib closing notification.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>protected void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdbot/EasyClient.html#setErrorCallback(it.ernytech.tdlib.utils.ErrorCallback)">setErrorCallback</a></span>​(<a href="../../../it/ernytech/tdlib/utils/ErrorCallback.html" title="interface in it.ernytech.tdlib.utils">ErrorCallback</a> errorCallback)</code></th> <td class="colLast"> <div class="block">Set the default callback for general error updates (no response to requests).</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>protected void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdbot/EasyClient.html#setUpdateCallback(it.ernytech.tdlib.utils.ReceiveCallback)">setUpdateCallback</a></span>​(<a href="../../../it/ernytech/tdlib/utils/ReceiveCallback.html" title="interface in it.ernytech.tdlib.utils">ReceiveCallback</a> receiveCallback)</code></th> <td class="colLast"> <div class="block">Set the default callback for general updates (no response to requests).</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </section> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="field.detail"> <!-- --> </a> <h3>Field Detail</h3> <a id="haveAuthorization"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>haveAuthorization</h4> <pre>protected volatile boolean haveAuthorization</pre> </li> </ul> </li> </ul> </section> <!-- ========= CONSTRUCTOR DETAIL ======== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a id="<init>(it.ernytech.tdbot.AuthorizationHandler)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>EasyClient</h4> <pre>protected EasyClient​(<a href="../../../it/ernytech/tdbot/AuthorizationHandler.html" title="interface in it.ernytech.tdbot">AuthorizationHandler</a> authorizationHandler)</pre> <div class="block">Creates a new EasyClient.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>authorizationHandler</code> - Callback to be implemented in the client to manage the authorization.</dd> </dl> </li> </ul> </li> </ul> </section> <!-- ============ METHOD DETAIL ========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a id="send(it.ernytech.tdlib.TdApi.Function)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>send</h4> <pre>protected long send​(<a href="../../../it/ernytech/tdlib/TdApi.Function.html" title="class in it.ernytech.tdlib">TdApi.Function</a> function)</pre> <div class="block">Send a request to tdlib without waiting for the result.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>function</code> - TDLib API function representing a request to TDLib.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>Request identifier. Responses to TDLib requests will have the same id as the corresponding request.</dd> </dl> </li> </ul> <a id="execute(it.ernytech.tdlib.TdApi.Function,it.ernytech.tdlib.utils.ReceiveCallback,it.ernytech.tdlib.utils.ErrorCallback)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>execute</h4> <pre>protected void execute​(<a href="../../../it/ernytech/tdlib/TdApi.Function.html" title="class in it.ernytech.tdlib">TdApi.Function</a> function, <a href="../../../it/ernytech/tdlib/utils/ReceiveCallback.html" title="interface in it.ernytech.tdlib.utils">ReceiveCallback</a> receiveCallback, <a href="../../../it/ernytech/tdlib/utils/ErrorCallback.html" title="interface in it.ernytech.tdlib.utils">ErrorCallback</a> errorCallback)</pre> <div class="block">Send a request to tdlib and send the response to the callbacks.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>function</code> - TDLib API function representing a request to TDLib.</dd> <dd><code>receiveCallback</code> - Interface of callback for receive incoming update or request response.</dd> <dd><code>errorCallback</code> - Interface of callback for receive incoming error response.</dd> </dl> </li> </ul> <a id="execute(it.ernytech.tdlib.TdApi.Function)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>execute</h4> <pre>protected <a href="../../../it/ernytech/tdlib/Response.html" title="class in it.ernytech.tdlib">Response</a> execute​(<a href="../../../it/ernytech/tdlib/TdApi.Function.html" title="class in it.ernytech.tdlib">TdApi.Function</a> function)</pre> <div class="block">Send a request to tdlib, wait for the result and return the response.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>function</code> - TDLib API function representing a request to TDLib.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>A response to a request.</dd> </dl> </li> </ul> <a id="setUpdateCallback(it.ernytech.tdlib.utils.ReceiveCallback)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setUpdateCallback</h4> <pre>protected void setUpdateCallback​(<a href="../../../it/ernytech/tdlib/utils/ReceiveCallback.html" title="interface in it.ernytech.tdlib.utils">ReceiveCallback</a> receiveCallback)</pre> <div class="block">Set the default callback for general updates (no response to requests).</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>receiveCallback</code> - Interface of callback for receive incoming update or request response.</dd> </dl> </li> </ul> <a id="setErrorCallback(it.ernytech.tdlib.utils.ErrorCallback)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setErrorCallback</h4> <pre>protected void setErrorCallback​(<a href="../../../it/ernytech/tdlib/utils/ErrorCallback.html" title="interface in it.ernytech.tdlib.utils">ErrorCallback</a> errorCallback)</pre> <div class="block">Set the default callback for general error updates (no response to requests).</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>errorCallback</code> - Interface of callback for receive incoming error response.</dd> </dl> </li> </ul> <a id="setCloseCallback(it.ernytech.tdlib.utils.CloseCallback)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setCloseCallback</h4> <pre>protected void setCloseCallback​(<a href="../../../it/ernytech/tdlib/utils/CloseCallback.html" title="interface in it.ernytech.tdlib.utils">CloseCallback</a> closeCallback)</pre> <div class="block">Set the default callback for Tdlib closing notification.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>closeCallback</code> - Interface of callback for receive notification of closing Tdlib.</dd> </dl> </li> </ul> <a id="destroyBotClient()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>destroyBotClient</h4> <pre>protected void destroyBotClient()</pre> <div class="block">Destroys the client and TDLib instance.</div> </li> </ul> <a id="authorizationHandler(it.ernytech.tdlib.TdApi.UpdateAuthorizationState)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>authorizationHandler</h4> <pre>protected void authorizationHandler​(<a href="../../../it/ernytech/tdlib/TdApi.UpdateAuthorizationState.html" title="class in it.ernytech.tdlib">TdApi.UpdateAuthorizationState</a> authorizationState)</pre> <div class="block">Manages the authorization state updates.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>authorizationState</code> - The status of the authorization.</dd> </dl> </li> </ul> </li> </ul> </section> </li> </ul> </div> </div> </main> <!-- ========= END OF CLASS DATA ========= --> <footer role="contentinfo"> <nav role="navigation"> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a id="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../it/ernytech/tdbot/ConstructorDetector.html" title="class in it.ernytech.tdbot"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../it/ernytech/tdbot/UserClient.html" title="class in it.ernytech.tdbot"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?it/ernytech/tdbot/EasyClient.html" target="_top">Frames</a></li> <li><a href="EasyClient.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a id="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </nav> </footer> </body> </html>