UNPKG

zego-express-engine-reactnative

Version:

React Native Zego Express Video for Android & iOS

240 lines 9.94 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ZegoRoomExtraInfo | zego-express-engine-reactnative</title> <meta name="description" content="Documentation for zego-express-engine-reactnative"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">zego-express-engine-reactnative</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/_zegoexpressdefines_.html">&quot;ZegoExpressDefines&quot;</a> </li> <li> <a href="_zegoexpressdefines_.zegoroomextrainfo.html">ZegoRoomExtraInfo</a> </li> </ul> <h1>Interface ZegoRoomExtraInfo</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Room extra information.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">ZegoRoomExtraInfo</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section tsd-is-external"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegoroomextrainfo.html#key" class="tsd-kind-icon">key</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegoroomextrainfo.html#updatetime" class="tsd-kind-icon">update<wbr>Time</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegoroomextrainfo.html#updateuser" class="tsd-kind-icon">update<wbr>User</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegoroomextrainfo.html#value" class="tsd-kind-icon">value</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="key" class="tsd-anchor"></a> <h3>key</h3> <div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:1123</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The key of the room extra information.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="updatetime" class="tsd-anchor"></a> <h3>update<wbr>Time</h3> <div class="tsd-signature tsd-kind-icon">update<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:1132</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Update time of the room extra information, UNIX timestamp, in milliseconds.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="updateuser" class="tsd-anchor"></a> <h3>update<wbr>User</h3> <div class="tsd-signature tsd-kind-icon">update<wbr>User<span class="tsd-signature-symbol">:</span> <a href="../classes/_zegoexpressdefines_.zegouser.html" class="tsd-signature-type">ZegoUser</a></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:1129</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The user who update the room extra information.Please do not fill in sensitive user information in this field, including but not limited to mobile phone number, ID number, passport number, real name, etc.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="value" class="tsd-anchor"></a> <h3>value</h3> <div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:1126</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The value of the room extra information.</p> </div> </div> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="label tsd-is-external"> <span>Internals</span> </li> <li class=" tsd-kind-module"> <a href="../modules/_index_.html">&quot;index&quot;</a> </li> <li class="label tsd-is-external"> <span>Externals</span> </li> <li class="current tsd-kind-module tsd-is-external"> <a href="../modules/_zegoexpressdefines_.html">&quot;<wbr>Zego<wbr>Express<wbr>Defines&quot;</a> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="../modules/_zegoexpressengine_.html">&quot;<wbr>Zego<wbr>Express<wbr>Engine&quot;</a> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="../modules/_zegoexpresseventhandler_.html">&quot;<wbr>Zego<wbr>Express<wbr>Event<wbr>Handler&quot;</a> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="../modules/_zegorenderview_.html">&quot;<wbr>Zego<wbr>Render<wbr>View&quot;</a> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="../modules/_impl_zegoexpressengineimpl_.html">&quot;impl/<wbr>Zego<wbr>Express<wbr>Engine<wbr>Impl&quot;</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_zegoexpressdefines_.zegoroomextrainfo.html" class="tsd-kind-icon">Zego<wbr>Room<wbr>Extra<wbr>Info</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_zegoexpressdefines_.zegoroomextrainfo.html#key" class="tsd-kind-icon">key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_zegoexpressdefines_.zegoroomextrainfo.html#updatetime" class="tsd-kind-icon">update<wbr>Time</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_zegoexpressdefines_.zegoroomextrainfo.html#updateuser" class="tsd-kind-icon">update<wbr>User</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_zegoexpressdefines_.zegoroomextrainfo.html#value" class="tsd-kind-icon">value</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> </body> </html>