tdlight-team/tdlight-docs
1
1
Fork 0
Code Releases Activity
2a6212e032
tdlight-docs/tdlight.api/it/tdlight/jni/TdApi.SearchChatMessages.html
Andrea Cavalli 2a6212e032 Update javadocs
2023-06-05 20:15:36 +00:00

454 lines
31 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>TdApi.SearchChatMessages (TDLight API 4.0.404 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"><style>
#memberSummary_tabpanel{overflow-x: auto;}
li.blockList{overflow-x: auto;}
td.colLast div{max-width:30vw;}
#search{width: 400px;max-width: 65vw;}
.title,.subTitle,pre,.inheritance,h1,h2,h3,h4,h5,.memberSummary,.memberSignature,.typeSummary,.blockList,.contentContainer{white-space:normal;word-break:break-word;}
ul{padding-left:10px}
</style>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: module: tdlight.api, package: it.tdlight.jni, class: TdApi, class: SearchChatMessages">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/TdApi.SearchChatMessages.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<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="sub-nav-list">
<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>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../module-summary.html">tdlight.api</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">it.tdlight.jni</a></div>
<h1 title="Class TdApi.SearchChatMessages" class="title">Class TdApi.SearchChatMessages</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="TdApi.Object.html" title="class in it.tdlight.jni">it.tdlight.jni.TdApi.Object</a>
<div class="inheritance"><a href="TdApi.Function.html" title="class in it.tdlight.jni">it.tdlight.jni.TdApi.Function</a>&lt;<a href="TdApi.FoundChatMessages.html" title="class in it.tdlight.jni">TdApi.FoundChatMessages</a>&gt;
<div class="inheritance">it.tdlight.jni.TdApi.SearchChatMessages</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="TdApi.html" title="class in it.tdlight.jni">TdApi</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static final class </span><span class="element-name type-name-label">TdApi.SearchChatMessages</span>
<span class="extends-implements">extends <a href="TdApi.Function.html" title="class in it.tdlight.jni">TdApi.Function</a>&lt;<a href="TdApi.FoundChatMessages.html" title="class in it.tdlight.jni">TdApi.FoundChatMessages</a>&gt;</span></div>
<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 must be used instead), or without an enabled
message database. For optimal performance, the number of returned
messages is chosen by TDLib and can be smaller than the specified
limit. A combination of query, senderId, filter and messageThreadId
search criteria is expected to be supported, only if it is required
for Telegram official application implementation.
<p> Returns <a href="TdApi.FoundChatMessages.html" title="class in it.tdlight.jni"><code>FoundChatMessages</code></a> </p></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>long</code></div>
<div class="col-second even-row-color"><code><a href="#chatId" class="member-name-link">chatId</a></code></div>
<div class="col-last even-row-color">
<div class="block">Identifier of the chat in which to search messages.</div>
</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#CONSTRUCTOR" class="member-name-link">CONSTRUCTOR</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Identifier uniquely determining type of the object.</div>
</div>
<div class="col-first even-row-color"><code><a href="TdApi.SearchMessagesFilter.html" title="class in it.tdlight.jni">TdApi.SearchMessagesFilter</a></code></div>
<div class="col-second even-row-color"><code><a href="#filter" class="member-name-link">filter</a></code></div>
<div class="col-last even-row-color">
<div class="block">Additional filter for messages to search; pass null to search for all messages.</div>
</div>
<div class="col-first odd-row-color"><code>long</code></div>
<div class="col-second odd-row-color"><code><a href="#fromMessageId" class="member-name-link">fromMessageId</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Identifier of the message starting from which history must be fetched; use 0 to get results from the last message.</div>
</div>
<div class="col-first even-row-color"><code>int</code></div>
<div class="col-second even-row-color"><code><a href="#limit" class="member-name-link">limit</a></code></div>
<div class="col-last even-row-color">
<div class="block">The maximum number of messages to be returned; must be positive and can&#039;t be greater than 100.</div>
</div>
<div class="col-first odd-row-color"><code>long</code></div>
<div class="col-second odd-row-color"><code><a href="#messageThreadId" class="member-name-link">messageThreadId</a></code></div>
<div class="col-last odd-row-color">
<div class="block">If not 0, only messages in the specified thread will be returned; supergroups only.</div>
</div>
<div class="col-first even-row-color"><code>int</code></div>
<div class="col-second even-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
<div class="col-last even-row-color">
<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>
</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#query" class="member-name-link">query</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Query to search for.</div>
</div>
<div class="col-first even-row-color"><code><a href="TdApi.MessageSender.html" title="class in it.tdlight.jni">TdApi.MessageSender</a></code></div>
<div class="col-second even-row-color"><code><a href="#senderId" class="member-name-link">senderId</a></code></div>
<div class="col-last even-row-color">
<div class="block">Identifier of the sender of messages to search for; pass null to search for messages from any sender.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SearchChatMessages</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Searches for messages with given words in the chat.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(long,java.lang.String,it.tdlight.jni.TdApi.MessageSender,long,int,int,it.tdlight.jni.TdApi.SearchMessagesFilter,long)" class="member-name-link">SearchChatMessages</a><wbr>(long&nbsp;chatId,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;query,
<a href="TdApi.MessageSender.html" title="class in it.tdlight.jni">TdApi.MessageSender</a>&nbsp;senderId,
long&nbsp;fromMessageId,
int&nbsp;offset,
int&nbsp;limit,
<a href="TdApi.SearchMessagesFilter.html" title="class in it.tdlight.jni">TdApi.SearchMessagesFilter</a>&nbsp;filter,
long&nbsp;messageThreadId)</code></div>
<div class="col-last odd-row-color">
<div class="block">Searches for messages with given words in the chat.</div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.io.DataInput)" class="member-name-link">SearchChatMessages</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInput.html" title="class or interface in java.io" class="external-link">DataInput</a>&nbsp;input)</code></div>
<div class="col-last even-row-color">
<div class="block">Searches for messages with given words in the chat.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;o)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConstructor()" class="member-name-link">getConstructor</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns an identifier uniquely determining type of the object.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serialize(java.io.DataOutput)" class="member-name-link">serialize</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataOutput.html" title="class or interface in java.io" class="external-link">DataOutput</a>&nbsp;output)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Serialize the TDLib class</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-it.tdlight.jni.TdApi.Function">Methods inherited from class&nbsp;it.tdlight.jni.<a href="TdApi.Function.html" title="class in it.tdlight.jni">TdApi.Function</a></h3>
<code><a href="TdApi.Function.html#toString()">toString</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-it.tdlight.jni.TdApi.Object">Methods inherited from class&nbsp;it.tdlight.jni.<a href="TdApi.Object.html" title="class in it.tdlight.jni">TdApi.Object</a></h3>
<code><a href="TdApi.Object.html#serialize()">serialize</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="chatId">
<h3>chatId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">chatId</span></div>
<div class="block">Identifier of the chat in which to search messages.</div>
</section>
</li>
<li>
<section class="detail" id="query">
<h3>query</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">query</span></div>
<div class="block">Query to search for.</div>
</section>
</li>
<li>
<section class="detail" id="senderId">
<h3>senderId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TdApi.MessageSender.html" title="class in it.tdlight.jni">TdApi.MessageSender</a></span>&nbsp;<span class="element-name">senderId</span></div>
<div class="block">Identifier of the sender of messages to search for; pass null to search for messages from any sender. Not supported in secret chats.</div>
</section>
</li>
<li>
<section class="detail" id="fromMessageId">
<h3>fromMessageId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">fromMessageId</span></div>
<div class="block">Identifier of the message starting from which history must be fetched; use 0 to get results from the last message.</div>
</section>
</li>
<li>
<section class="detail" id="offset">
<h3>offset</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">offset</span></div>
<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>
</section>
</li>
<li>
<section class="detail" id="limit">
<h3>limit</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">limit</span></div>
<div class="block">The maximum number of messages to be returned; must be positive and can&#039;t be greater than 100. If the offset is negative, the limit must be greater than -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.</div>
</section>
</li>
<li>
<section class="detail" id="filter">
<h3>filter</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TdApi.SearchMessagesFilter.html" title="class in it.tdlight.jni">TdApi.SearchMessagesFilter</a></span>&nbsp;<span class="element-name">filter</span></div>
<div class="block">Additional filter for messages to search; pass null to search for all messages.</div>
</section>
</li>
<li>
<section class="detail" id="messageThreadId">
<h3>messageThreadId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">messageThreadId</span></div>
<div class="block">If not 0, only messages in the specified thread will be returned; supergroups only.</div>
</section>
</li>
<li>
<section class="detail" id="CONSTRUCTOR">
<h3>CONSTRUCTOR</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">CONSTRUCTOR</span></div>
<div class="block">Identifier uniquely determining type of the object.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../constant-values.html#it.tdlight.jni.TdApi.SearchChatMessages.CONSTRUCTOR">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>SearchChatMessages</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SearchChatMessages</span>()</div>
<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 must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit. A combination of query, senderId, filter and messageThreadId search criteria is expected to be supported, only if it is required for Telegram official application implementation.
<p> Returns <a href="TdApi.FoundChatMessages.html" title="class in it.tdlight.jni"><code>FoundChatMessages</code></a> </p></div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(long,java.lang.String,it.tdlight.jni.TdApi.MessageSender,long,int,int,it.tdlight.jni.TdApi.SearchMessagesFilter,long)">
<h3>SearchChatMessages</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SearchChatMessages</span><wbr><span class="parameters">(long&nbsp;chatId,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;query,
<a href="TdApi.MessageSender.html" title="class in it.tdlight.jni">TdApi.MessageSender</a>&nbsp;senderId,
long&nbsp;fromMessageId,
int&nbsp;offset,
int&nbsp;limit,
<a href="TdApi.SearchMessagesFilter.html" title="class in it.tdlight.jni">TdApi.SearchMessagesFilter</a>&nbsp;filter,
long&nbsp;messageThreadId)</span></div>
<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 must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit. A combination of query, senderId, filter and messageThreadId search criteria is expected to be supported, only if it is required for Telegram official application implementation.
<p> Returns <a href="TdApi.FoundChatMessages.html" title="class in it.tdlight.jni"><code>FoundChatMessages</code></a> </p></div>
<dl class="notes">
<dt>Parameters:</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>senderId</code> - Identifier of the sender of messages to search for; pass null to search for messages from any sender. 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 last message.</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&#039;t be greater than 100. If the offset is negative, the limit must be greater than -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.</dd>
<dd><code>filter</code> - Additional filter for messages to search; pass null to search for all messages.</dd>
<dd><code>messageThreadId</code> - If not 0, only messages in the specified thread will be returned; supergroups only.
<p> Returns <a href="TdApi.FoundChatMessages.html" title="class in it.tdlight.jni"><code>FoundChatMessages</code></a> </p></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.io.DataInput)">
<h3>SearchChatMessages</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SearchChatMessages</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInput.html" title="class or interface in java.io" class="external-link">DataInput</a>&nbsp;input)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<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 must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit. A combination of query, senderId, filter and messageThreadId search criteria is expected to be supported, only if it is required for Telegram official application implementation.
<p> Returns <a href="TdApi.FoundChatMessages.html" title="class in it.tdlight.jni"><code>FoundChatMessages</code></a> </p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>input</code> - Serialized input</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - the deserialization failed</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getConstructor()">
<h3>getConstructor</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getConstructor</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="TdApi.Object.html#getConstructor()">TdApi.Object</a></code></span></div>
<div class="block">Returns an identifier uniquely determining type of the object.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="TdApi.Object.html#getConstructor()">getConstructor</a></code>&nbsp;in class&nbsp;<code><a href="TdApi.Object.html" title="class in it.tdlight.jni">TdApi.Object</a></code></dd>
<dt>Returns:</dt>
<dd>this.CONSTRUCTOR</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="serialize(java.io.DataOutput)">
<h3>serialize</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">serialize</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataOutput.html" title="class or interface in java.io" class="external-link">DataOutput</a>&nbsp;output)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Serialize the TDLib class</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="TdApi.Object.html#serialize(java.io.DataOutput)">serialize</a></code>&nbsp;in class&nbsp;<code><a href="TdApi.Object.html" title="class in it.tdlight.jni">TdApi.Object</a></code></dd>
<dt>Parameters:</dt>
<dd><code>output</code> - output data stream</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - the serialization failed</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="equals(java.lang.Object)">
<h3>equals</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;o)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hashCode()">
<h3>hashCode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">hashCode</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
View Git Blame Copy Permalink