tdlight-team/tdlight-java
tdlight-team/tdlight-java
1
2
Fork 0
Code Issues Releases Wiki Activity
b2023ea9fc
tdlight-java/docs/it/ernytech/tdlib/TdApi.SearchChatMessages.html

558 lines
21 KiB
HTML
Raw Normal View History

Initial tdlib
2018-07-18 12:24:37 +02:00
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="it">
<head>
Support for jitpack - Support for jitpack - Updated docs - Added README - Added .gitignore - Clean up build.gralde
2018-07-18 17:02:05 +02:00
<!-- Generated by javadoc (10.0.1) on Wed Jul 18 16:33:16 CEST 2018 -->
Initial tdlib
2018-07-18 12:24:37 +02:00
<title>TdApi.SearchChatMessages</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="TdApi.SearchChatMessages";
}
}
catch(err) {
}
//-->
var methods = {"i0":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/tdlib/TdApi.SearchChatMembers.html" title="class in it.ernytech.tdlib"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../it/ernytech/tdlib/TdApi.SearchChatRecentLocationMessages.html" title="class in it.ernytech.tdlib"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?it/ernytech/tdlib/TdApi.SearchChatMessages.html" target="_top">Frames</a></li>
<li><a href="TdApi.SearchChatMessages.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="../../../it/ernytech/tdlib/package-summary.html">it.ernytech.tdlib</a></div>
<h2 title="Class TdApi.SearchChatMessages" class="title">Class TdApi.SearchChatMessages</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../it/ernytech/tdlib/TdApi.Object.html" title="class in it.ernytech.tdlib">it.ernytech.tdlib.TdApi.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../it/ernytech/tdlib/TdApi.Function.html" title="class in it.ernytech.tdlib">it.ernytech.tdlib.TdApi.Function</a></li>
<li>
<ul class="inheritance">
<li>it.ernytech.tdlib.TdApi.SearchChatMessages</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../it/ernytech/tdlib/TdApi.html" title="class in it.ernytech.tdlib">TdApi</a></dd>
</dl>
<hr>
<pre>public static class <span class="typeNameLabel">TdApi.SearchChatMessages</span>
extends <a href="../../../it/ernytech/tdlib/TdApi.Function.html" title="class in it.ernytech.tdlib">TdApi.Function</a></pre>
<div class="block">Searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing messageId. Cannot be used in secret chats with a non-empty query (searchSecretMessages should be used instead), or without an enabled message database. For optimal performance the number of returned messages is chosen by the library.
<p> Returns <a href="../../../it/ernytech/tdlib/TdApi.Messages.html" title="class in it.ernytech.tdlib"><code>Messages</code></a> </p></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">&nbsp;</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>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdlib/TdApi.SearchChatMessages.html#chatId">chatId</a></span></code></th>
<td class="colLast">
<div class="block">Identifier of the chat in which to search messages.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdlib/TdApi.SearchChatMessages.html#CONSTRUCTOR">CONSTRUCTOR</a></span></code></th>
<td class="colLast">
<div class="block">Identifier uniquely determining type of the object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../it/ernytech/tdlib/TdApi.SearchMessagesFilter.html" title="class in it.ernytech.tdlib">TdApi.SearchMessagesFilter</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdlib/TdApi.SearchChatMessages.html#filter">filter</a></span></code></th>
<td class="colLast">
<div class="block">Filter for message content in the search results.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdlib/TdApi.SearchChatMessages.html#fromMessageId">fromMessageId</a></span></code></th>
<td class="colLast">
<div class="block">Identifier of the message starting from which history must be fetched; use 0 to get results from the beginning.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdlib/TdApi.SearchChatMessages.html#limit">limit</a></span></code></th>
<td class="colLast">
<div class="block">The maximum number of messages to be returned; must be positive and can't be greater than 100.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdlib/TdApi.SearchChatMessages.html#offset">offset</a></span></code></th>
<td class="colLast">
<div class="block">Specify 0 to get results from exactly the fromMessageId or a negative offset to get the specified message and some newer messages.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdlib/TdApi.SearchChatMessages.html#query">query</a></span></code></th>
<td class="colLast">
<div class="block">Query to search for.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdlib/TdApi.SearchChatMessages.html#senderUserId">senderUserId</a></span></code></th>
<td class="colLast">
<div class="block">If not 0, only messages sent by the specified user will be returned.</div>
</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdlib/TdApi.SearchChatMessages.html#%3Cinit%3E()">SearchChatMessages</a></span>()</code></th>
<td class="colLast">
<div class="block">Default constructor.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdlib/TdApi.SearchChatMessages.html#%3Cinit%3E(long,java.lang.String,int,long,int,int,it.ernytech.tdlib.TdApi.SearchMessagesFilter)">SearchChatMessages</a></span>&#8203;(long&nbsp;chatId,
java.lang.String&nbsp;query,
int&nbsp;senderUserId,
long&nbsp;fromMessageId,
int&nbsp;offset,
int&nbsp;limit,
<a href="../../../it/ernytech/tdlib/TdApi.SearchMessagesFilter.html" title="class in it.ernytech.tdlib">TdApi.SearchMessagesFilter</a>&nbsp;filter)</code></th>
<td class="colLast">
<div class="block">Constructor for initialization of all fields.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../it/ernytech/tdlib/TdApi.SearchChatMessages.html#getConstructor()">getConstructor</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.it.ernytech.tdlib.TdApi.Function">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;it.ernytech.tdlib.<a href="../../../it/ernytech/tdlib/TdApi.Function.html" title="class in it.ernytech.tdlib">TdApi.Function</a></h3>
<code><a href="../../../it/ernytech/tdlib/TdApi.Function.html#toString()">toString</a></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="chatId">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>chatId</h4>
<pre>public&nbsp;long chatId</pre>
<div class="block">Identifier of the chat in which to search messages.</div>
</li>
</ul>
<a id="query">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre>public&nbsp;java.lang.String query</pre>
<div class="block">Query to search for.</div>
</li>
</ul>
<a id="senderUserId">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>senderUserId</h4>
<pre>public&nbsp;int senderUserId</pre>
<div class="block">If not 0, only messages sent by the specified user will be returned. Not supported in secret chats.</div>
</li>
</ul>
<a id="fromMessageId">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromMessageId</h4>
<pre>public&nbsp;long fromMessageId</pre>
<div class="block">Identifier of the message starting from which history must be fetched; use 0 to get results from the beginning.</div>
</li>
</ul>
<a id="offset">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offset</h4>
<pre>public&nbsp;int offset</pre>
<div class="block">Specify 0 to get results from exactly the fromMessageId or a negative offset to get the specified message and some newer messages.</div>
</li>
</ul>
<a id="limit">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>limit</h4>
<pre>public&nbsp;int limit</pre>
<div class="block">The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than -offset. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached.</div>
</li>
</ul>
<a id="filter">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filter</h4>
<pre>public&nbsp;<a href="../../../it/ernytech/tdlib/TdApi.SearchMessagesFilter.html" title="class in it.ernytech.tdlib">TdApi.SearchMessagesFilter</a> filter</pre>
<div class="block">Filter for message content in the search results.</div>
</li>
</ul>
<a id="CONSTRUCTOR">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CONSTRUCTOR</h4>
<pre>public static final&nbsp;int CONSTRUCTOR</pre>
<div class="block">Identifier uniquely determining type of the object.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#it.ernytech.tdlib.TdApi.SearchChatMessages.CONSTRUCTOR">Constant Field Values</a></dd>
</dl>
</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="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SearchChatMessages</h4>
<pre>public&nbsp;SearchChatMessages()</pre>
<div class="block">Default constructor.</div>
</li>
</ul>
<a id="&lt;init&gt;(long,java.lang.String,int,long,int,int,it.ernytech.tdlib.TdApi.SearchMessagesFilter)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SearchChatMessages</h4>
<pre>public&nbsp;SearchChatMessages&#8203;(long&nbsp;chatId,
java.lang.String&nbsp;query,
int&nbsp;senderUserId,
long&nbsp;fromMessageId,
int&nbsp;offset,
int&nbsp;limit,
<a href="../../../it/ernytech/tdlib/TdApi.SearchMessagesFilter.html" title="class in it.ernytech.tdlib">TdApi.SearchMessagesFilter</a>&nbsp;filter)</pre>
<div class="block">Constructor for initialization of all fields.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>chatId</code> - Identifier of the chat in which to search messages.</dd>
<dd><code>query</code> - Query to search for.</dd>
<dd><code>senderUserId</code> - If not 0, only messages sent by the specified user will be returned. Not supported in secret chats.</dd>
<dd><code>fromMessageId</code> - Identifier of the message starting from which history must be fetched; use 0 to get results from the beginning.</dd>
<dd><code>offset</code> - Specify 0 to get results from exactly the fromMessageId or a negative offset to get the specified message and some newer messages.</dd>
<dd><code>limit</code> - The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than -offset. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached.</dd>
<dd><code>filter</code> - Filter for message content in the search results.</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="getConstructor()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getConstructor</h4>
<pre>public&nbsp;int&nbsp;getConstructor()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../it/ernytech/tdlib/TdApi.Object.html#getConstructor()">getConstructor</a></code>&nbsp;in class&nbsp;<code><a href="../../../it/ernytech/tdlib/TdApi.Object.html" title="class in it.ernytech.tdlib">TdApi.Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this.CONSTRUCTOR</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/tdlib/TdApi.SearchChatMembers.html" title="class in it.ernytech.tdlib"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../it/ernytech/tdlib/TdApi.SearchChatRecentLocationMessages.html" title="class in it.ernytech.tdlib"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?it/ernytech/tdlib/TdApi.SearchChatMessages.html" target="_top">Frames</a></li>
<li><a href="TdApi.SearchChatMessages.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>
Copy Permalink