672 lines
42 KiB
HTML
672 lines
42 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>TdApi.Story (TDLight API 4.0.476 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: Story">
|
|
<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.Story.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: </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="sub-nav-list">
|
|
<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>
|
|
<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> <a href="../../../module-summary.html">tdlight.api</a></div>
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">it.tdlight.jni</a></div>
|
|
<h1 title="Class TdApi.Story" class="title">Class TdApi.Story</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">it.tdlight.jni.TdApi.Story</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.Story</span>
|
|
<span class="extends-implements">extends <a href="TdApi.Object.html" title="class in it.tdlight.jni">TdApi.Object</a></span></div>
|
|
<div class="block">Represents a story.</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><a href="TdApi.StoryArea.html" title="class in it.tdlight.jni">TdApi.StoryArea</a>[]</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#areas" class="member-name-link">areas</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Clickable areas to be shown on the story content.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#canBeDeleted" class="member-name-link">canBeDeleted</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">True, if the story can be deleted.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>boolean</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#canBeEdited" class="member-name-link">canBeEdited</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">True, if the story can be edited.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#canBeForwarded" class="member-name-link">canBeForwarded</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">True, if the story can be forwarded as a message.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>boolean</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#canBeReplied" class="member-name-link">canBeReplied</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">True, if the story can be replied in the chat with the story sender.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#canGetInteractions" class="member-name-link">canGetInteractions</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">True, if interactions with the story can be received through getStoryInteractions.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>boolean</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#canGetStatistics" class="member-name-link">canGetStatistics</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">True, if the story statistics are available through getStoryStatistics.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#canToggleIsPinned" class="member-name-link">canToggleIsPinned</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">True, if the story's isPinned value can be changed.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="TdApi.FormattedText.html" title="class in it.tdlight.jni">TdApi.FormattedText</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#caption" class="member-name-link">caption</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Caption of the story.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="TdApi.ReactionType.html" title="class in it.tdlight.jni">TdApi.ReactionType</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#chosenReactionType" class="member-name-link">chosenReactionType</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Type of the chosen reaction; may be null if none.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static final int</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#CONSTRUCTOR" class="member-name-link">CONSTRUCTOR</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Identifier uniquely determining type of the object.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="TdApi.StoryContent.html" title="class in it.tdlight.jni">TdApi.StoryContent</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#content" class="member-name-link">content</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Content of the story.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>int</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#date" class="member-name-link">date</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Point in time (Unix timestamp) when the story was published.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#hasExpiredViewers" class="member-name-link">hasExpiredViewers</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">True, if users viewed the story can't be received, because the story has expired more than getOption("story_viewers_expiration_delay") seconds ago.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>int</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#id" class="member-name-link">id</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Unique story identifier among stories of the given sender.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="TdApi.StoryInteractionInfo.html" title="class in it.tdlight.jni">TdApi.StoryInteractionInfo</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#interactionInfo" class="member-name-link">interactionInfo</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Information about interactions with the story; may be null if the story isn't owned or there were no interactions.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>boolean</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#isBeingEdited" class="member-name-link">isBeingEdited</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">True, if the story is being edited by the current user.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#isBeingSent" class="member-name-link">isBeingSent</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">True, if the story is being sent by the current user.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>boolean</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#isEdited" class="member-name-link">isEdited</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">True, if the story was edited.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#isPinned" class="member-name-link">isPinned</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">True, if the story is saved in the sender's profile and will be available there after expiration.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>boolean</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#isVisibleOnlyForSelf" class="member-name-link">isVisibleOnlyForSelf</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">True, if the story is visible only for the current user.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="TdApi.StoryPrivacySettings.html" title="class in it.tdlight.jni">TdApi.StoryPrivacySettings</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#privacySettings" class="member-name-link">privacySettings</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Privacy rules affecting story visibility; may be approximate for non-owned stories.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="TdApi.StoryRepostInfo.html" title="class in it.tdlight.jni">TdApi.StoryRepostInfo</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#repostInfo" class="member-name-link">repostInfo</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Information about the original story; may be null if the story wasn't reposted.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>long</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#senderChatId" class="member-name-link">senderChatId</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Identifier of the chat that posted the story.</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 the story; may be null if the story is posted on behalf of the senderChatId.</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">Story</a>()</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Represents a story.</div>
|
|
</div>
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int,long,it.tdlight.jni.TdApi.MessageSender,int,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,it.tdlight.jni.TdApi.StoryRepostInfo,it.tdlight.jni.TdApi.StoryInteractionInfo,it.tdlight.jni.TdApi.ReactionType,it.tdlight.jni.TdApi.StoryPrivacySettings,it.tdlight.jni.TdApi.StoryContent,it.tdlight.jni.TdApi.StoryArea%5B%5D,it.tdlight.jni.TdApi.FormattedText)" class="member-name-link">Story</a><wbr>(int id,
|
|
long senderChatId,
|
|
<a href="TdApi.MessageSender.html" title="class in it.tdlight.jni">TdApi.MessageSender</a> senderId,
|
|
int date,
|
|
boolean isBeingSent,
|
|
boolean isBeingEdited,
|
|
boolean isEdited,
|
|
boolean isPinned,
|
|
boolean isVisibleOnlyForSelf,
|
|
boolean canBeDeleted,
|
|
boolean canBeEdited,
|
|
boolean canBeForwarded,
|
|
boolean canBeReplied,
|
|
boolean canToggleIsPinned,
|
|
boolean canGetStatistics,
|
|
boolean canGetInteractions,
|
|
boolean hasExpiredViewers,
|
|
<a href="TdApi.StoryRepostInfo.html" title="class in it.tdlight.jni">TdApi.StoryRepostInfo</a> repostInfo,
|
|
<a href="TdApi.StoryInteractionInfo.html" title="class in it.tdlight.jni">TdApi.StoryInteractionInfo</a> interactionInfo,
|
|
<a href="TdApi.ReactionType.html" title="class in it.tdlight.jni">TdApi.ReactionType</a> chosenReactionType,
|
|
<a href="TdApi.StoryPrivacySettings.html" title="class in it.tdlight.jni">TdApi.StoryPrivacySettings</a> privacySettings,
|
|
<a href="TdApi.StoryContent.html" title="class in it.tdlight.jni">TdApi.StoryContent</a> content,
|
|
<a href="TdApi.StoryArea.html" title="class in it.tdlight.jni">TdApi.StoryArea</a>[] areas,
|
|
<a href="TdApi.FormattedText.html" title="class in it.tdlight.jni">TdApi.FormattedText</a> caption)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Represents a story.</div>
|
|
</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.io.DataInput)" class="member-name-link">Story</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> input)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Represents a story.</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> o)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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"> </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> 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.Object">Methods inherited from class 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>, <a href="TdApi.Object.html#toString()">toString</a></code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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="id">
|
|
<h3>id</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">id</span></div>
|
|
<div class="block">Unique story identifier among stories of the given sender.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="senderChatId">
|
|
<h3>senderChatId</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">senderChatId</span></div>
|
|
<div class="block">Identifier of the chat that posted the story.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="senderId">
|
|
<h3>senderId</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TdApi.MessageSender.html" title="class in it.tdlight.jni">TdApi.MessageSender</a></span> <span class="element-name">senderId</span></div>
|
|
<div class="block">Identifier of the sender of the story; may be null if the story is posted on behalf of the senderChatId.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="date">
|
|
<h3>date</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">date</span></div>
|
|
<div class="block">Point in time (Unix timestamp) when the story was published.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isBeingSent">
|
|
<h3>isBeingSent</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isBeingSent</span></div>
|
|
<div class="block">True, if the story is being sent by the current user.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isBeingEdited">
|
|
<h3>isBeingEdited</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isBeingEdited</span></div>
|
|
<div class="block">True, if the story is being edited by the current user.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isEdited">
|
|
<h3>isEdited</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEdited</span></div>
|
|
<div class="block">True, if the story was edited.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isPinned">
|
|
<h3>isPinned</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isPinned</span></div>
|
|
<div class="block">True, if the story is saved in the sender's profile and will be available there after expiration.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isVisibleOnlyForSelf">
|
|
<h3>isVisibleOnlyForSelf</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isVisibleOnlyForSelf</span></div>
|
|
<div class="block">True, if the story is visible only for the current user.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canBeDeleted">
|
|
<h3>canBeDeleted</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">canBeDeleted</span></div>
|
|
<div class="block">True, if the story can be deleted.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canBeEdited">
|
|
<h3>canBeEdited</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">canBeEdited</span></div>
|
|
<div class="block">True, if the story can be edited.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canBeForwarded">
|
|
<h3>canBeForwarded</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">canBeForwarded</span></div>
|
|
<div class="block">True, if the story can be forwarded as a message. Otherwise, screenshots and saving of the story content must be also forbidden.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canBeReplied">
|
|
<h3>canBeReplied</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">canBeReplied</span></div>
|
|
<div class="block">True, if the story can be replied in the chat with the story sender.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canToggleIsPinned">
|
|
<h3>canToggleIsPinned</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">canToggleIsPinned</span></div>
|
|
<div class="block">True, if the story's isPinned value can be changed.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canGetStatistics">
|
|
<h3>canGetStatistics</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">canGetStatistics</span></div>
|
|
<div class="block">True, if the story statistics are available through getStoryStatistics.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canGetInteractions">
|
|
<h3>canGetInteractions</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">canGetInteractions</span></div>
|
|
<div class="block">True, if interactions with the story can be received through getStoryInteractions.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hasExpiredViewers">
|
|
<h3>hasExpiredViewers</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasExpiredViewers</span></div>
|
|
<div class="block">True, if users viewed the story can't be received, because the story has expired more than getOption("story_viewers_expiration_delay") seconds ago.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="repostInfo">
|
|
<h3>repostInfo</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TdApi.StoryRepostInfo.html" title="class in it.tdlight.jni">TdApi.StoryRepostInfo</a></span> <span class="element-name">repostInfo</span></div>
|
|
<div class="block">Information about the original story; may be null if the story wasn't reposted.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="interactionInfo">
|
|
<h3>interactionInfo</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TdApi.StoryInteractionInfo.html" title="class in it.tdlight.jni">TdApi.StoryInteractionInfo</a></span> <span class="element-name">interactionInfo</span></div>
|
|
<div class="block">Information about interactions with the story; may be null if the story isn't owned or there were no interactions.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="chosenReactionType">
|
|
<h3>chosenReactionType</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TdApi.ReactionType.html" title="class in it.tdlight.jni">TdApi.ReactionType</a></span> <span class="element-name">chosenReactionType</span></div>
|
|
<div class="block">Type of the chosen reaction; may be null if none.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="privacySettings">
|
|
<h3>privacySettings</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TdApi.StoryPrivacySettings.html" title="class in it.tdlight.jni">TdApi.StoryPrivacySettings</a></span> <span class="element-name">privacySettings</span></div>
|
|
<div class="block">Privacy rules affecting story visibility; may be approximate for non-owned stories.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="content">
|
|
<h3>content</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TdApi.StoryContent.html" title="class in it.tdlight.jni">TdApi.StoryContent</a></span> <span class="element-name">content</span></div>
|
|
<div class="block">Content of the story.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="areas">
|
|
<h3>areas</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TdApi.StoryArea.html" title="class in it.tdlight.jni">TdApi.StoryArea</a>[]</span> <span class="element-name">areas</span></div>
|
|
<div class="block">Clickable areas to be shown on the story content.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="caption">
|
|
<h3>caption</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TdApi.FormattedText.html" title="class in it.tdlight.jni">TdApi.FormattedText</a></span> <span class="element-name">caption</span></div>
|
|
<div class="block">Caption of the story.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="CONSTRUCTOR">
|
|
<h3>CONSTRUCTOR</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <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.Story.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="<init>()">
|
|
<h3>Story</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Story</span>()</div>
|
|
<div class="block">Represents a story.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(int,long,it.tdlight.jni.TdApi.MessageSender,int,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,boolean,it.tdlight.jni.TdApi.StoryRepostInfo,it.tdlight.jni.TdApi.StoryInteractionInfo,it.tdlight.jni.TdApi.ReactionType,it.tdlight.jni.TdApi.StoryPrivacySettings,it.tdlight.jni.TdApi.StoryContent,it.tdlight.jni.TdApi.StoryArea[],it.tdlight.jni.TdApi.FormattedText)">
|
|
<h3>Story</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Story</span><wbr><span class="parameters">(int id,
|
|
long senderChatId,
|
|
<a href="TdApi.MessageSender.html" title="class in it.tdlight.jni">TdApi.MessageSender</a> senderId,
|
|
int date,
|
|
boolean isBeingSent,
|
|
boolean isBeingEdited,
|
|
boolean isEdited,
|
|
boolean isPinned,
|
|
boolean isVisibleOnlyForSelf,
|
|
boolean canBeDeleted,
|
|
boolean canBeEdited,
|
|
boolean canBeForwarded,
|
|
boolean canBeReplied,
|
|
boolean canToggleIsPinned,
|
|
boolean canGetStatistics,
|
|
boolean canGetInteractions,
|
|
boolean hasExpiredViewers,
|
|
<a href="TdApi.StoryRepostInfo.html" title="class in it.tdlight.jni">TdApi.StoryRepostInfo</a> repostInfo,
|
|
<a href="TdApi.StoryInteractionInfo.html" title="class in it.tdlight.jni">TdApi.StoryInteractionInfo</a> interactionInfo,
|
|
<a href="TdApi.ReactionType.html" title="class in it.tdlight.jni">TdApi.ReactionType</a> chosenReactionType,
|
|
<a href="TdApi.StoryPrivacySettings.html" title="class in it.tdlight.jni">TdApi.StoryPrivacySettings</a> privacySettings,
|
|
<a href="TdApi.StoryContent.html" title="class in it.tdlight.jni">TdApi.StoryContent</a> content,
|
|
<a href="TdApi.StoryArea.html" title="class in it.tdlight.jni">TdApi.StoryArea</a>[] areas,
|
|
<a href="TdApi.FormattedText.html" title="class in it.tdlight.jni">TdApi.FormattedText</a> caption)</span></div>
|
|
<div class="block">Represents a story.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>id</code> - Unique story identifier among stories of the given sender.</dd>
|
|
<dd><code>senderChatId</code> - Identifier of the chat that posted the story.</dd>
|
|
<dd><code>senderId</code> - Identifier of the sender of the story; may be null if the story is posted on behalf of the senderChatId.</dd>
|
|
<dd><code>date</code> - Point in time (Unix timestamp) when the story was published.</dd>
|
|
<dd><code>isBeingSent</code> - True, if the story is being sent by the current user.</dd>
|
|
<dd><code>isBeingEdited</code> - True, if the story is being edited by the current user.</dd>
|
|
<dd><code>isEdited</code> - True, if the story was edited.</dd>
|
|
<dd><code>isPinned</code> - True, if the story is saved in the sender's profile and will be available there after expiration.</dd>
|
|
<dd><code>isVisibleOnlyForSelf</code> - True, if the story is visible only for the current user.</dd>
|
|
<dd><code>canBeDeleted</code> - True, if the story can be deleted.</dd>
|
|
<dd><code>canBeEdited</code> - True, if the story can be edited.</dd>
|
|
<dd><code>canBeForwarded</code> - True, if the story can be forwarded as a message. Otherwise, screenshots and saving of the story content must be also forbidden.</dd>
|
|
<dd><code>canBeReplied</code> - True, if the story can be replied in the chat with the story sender.</dd>
|
|
<dd><code>canToggleIsPinned</code> - True, if the story's isPinned value can be changed.</dd>
|
|
<dd><code>canGetStatistics</code> - True, if the story statistics are available through getStoryStatistics.</dd>
|
|
<dd><code>canGetInteractions</code> - True, if interactions with the story can be received through getStoryInteractions.</dd>
|
|
<dd><code>hasExpiredViewers</code> - True, if users viewed the story can't be received, because the story has expired more than getOption("story_viewers_expiration_delay") seconds ago.</dd>
|
|
<dd><code>repostInfo</code> - Information about the original story; may be null if the story wasn't reposted.</dd>
|
|
<dd><code>interactionInfo</code> - Information about interactions with the story; may be null if the story isn't owned or there were no interactions.</dd>
|
|
<dd><code>chosenReactionType</code> - Type of the chosen reaction; may be null if none.</dd>
|
|
<dd><code>privacySettings</code> - Privacy rules affecting story visibility; may be approximate for non-owned stories.</dd>
|
|
<dd><code>content</code> - Content of the story.</dd>
|
|
<dd><code>areas</code> - Clickable areas to be shown on the story content.</dd>
|
|
<dd><code>caption</code> - Caption of the story.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(java.io.DataInput)">
|
|
<h3>Story</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Story</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> 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">Represents a story.</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> <span class="return-type">int</span> <span class="element-name">getConstructor</span>()</div>
|
|
<div class="block"><span class="descfrm-type-label">Description copied from class: <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> in class <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> <span class="return-type">void</span> <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> 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> in class <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> <span class="return-type">boolean</span> <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> 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> in class <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> <span class="return-type">int</span> <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> in class <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 © 2024. All rights reserved.</small></p>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|