1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060 |
- <!doctype html>
- <html class="default no-js">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <title>AgoraView | react-native-agora</title>
- <meta name="description" content="">
- <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.js" 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">react-native-agora</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="agoraview.html">AgoraView</a>
- </li>
- </ul>
- <h1>Class AgoraView<S, SS, S></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>AgoraView is the render layer for rendering video stream</p>
- </div>
- <p>This class is used to rendering native sdk stream</p>
- <dl class="tsd-comment-tags">
- <dt>props</dt>
- <dd><p>{@link AgoraViewProps}</p>
- </dd>
- </dl>
- </div>
- </section>
- <section class="tsd-panel tsd-type-parameters">
- <h3>Type parameters</h3>
- <ul class="tsd-type-parameters">
- <li>
- <h4>S</h4>
- </li>
- <li>
- <h4>SS</h4>
- </li>
- <li>
- <h4>S</h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-hierarchy">
- <h3>Hierarchy</h3>
- <ul class="tsd-hierarchy">
- <li>
- <span class="tsd-signature-type">Component</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span>
- <ul class="tsd-hierarchy">
- <li>
- <span class="target">AgoraView</span>
- </li>
- </ul>
- </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-inherited">
- <h3>Constructors</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#constructor" class="tsd-kind-icon">constructor</a></li>
- </ul>
- </section>
- <section class="tsd-index-section tsd-is-inherited">
- <h3>Properties</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#context" class="tsd-kind-icon">context</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#props" class="tsd-kind-icon">props</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#refs" class="tsd-kind-icon">refs</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#state" class="tsd-kind-icon">state</a></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="agoraview.html#contexttype" class="tsd-kind-icon">context<wbr>Type</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Methods</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#unsafe_componentwillmount" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Mount</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#unsafe_componentwillreceiveprops" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#unsafe_componentwillupdate" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Update</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentdidcatch" class="tsd-kind-icon">component<wbr>Did<wbr>Catch</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentdidmount" class="tsd-kind-icon">component<wbr>Did<wbr>Mount</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentdidupdate" class="tsd-kind-icon">component<wbr>Did<wbr>Update</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentwillmount" class="tsd-kind-icon">component<wbr>Will<wbr>Mount</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentwillreceiveprops" class="tsd-kind-icon">component<wbr>Will<wbr>Receive<wbr>Props</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentwillunmount" class="tsd-kind-icon">component<wbr>Will<wbr>Unmount</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentwillupdate" class="tsd-kind-icon">component<wbr>Will<wbr>Update</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#forceupdate" class="tsd-kind-icon">force<wbr>Update</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="agoraview.html#gethtmlprops" class="tsd-kind-icon">getHTMLProps</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#getsnapshotbeforeupdate" class="tsd-kind-icon">get<wbr>Snapshot<wbr>Before<wbr>Update</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="agoraview.html#render" class="tsd-kind-icon">render</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="agoraview.html#setstate" class="tsd-kind-icon">set<wbr>State</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#shouldcomponentupdate" class="tsd-kind-icon">should<wbr>Component<wbr>Update</a></li>
- </ul>
- </section>
- </div>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group tsd-is-inherited">
- <h2>Constructors</h2>
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
- <a name="constructor" class="tsd-anchor"></a>
- <h3>constructor</h3>
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">new <wbr>Agora<wbr>View<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="agoraview.html" class="tsd-signature-type">AgoraView</a></li>
- <li class="tsd-signature tsd-kind-icon">new <wbr>Agora<wbr>View<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AgoraViewProps</span>, context<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="agoraview.html" class="tsd-signature-type">AgoraView</a></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from Component.__constructor</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:404</li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>props: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <a href="agoraview.html" class="tsd-signature-type">AgoraView</a></h4>
- </li>
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from Component.__constructor</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:406</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <dl class="tsd-comment-tags">
- <dt>deprecated</dt>
- <dd></dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/docs/legacy-context.html">https://reactjs.org/docs/legacy-context.html</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>props: <span class="tsd-signature-type">AgoraViewProps</span></h5>
- </li>
- <li>
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> context: <span class="tsd-signature-type">any</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <a href="agoraview.html" class="tsd-signature-type">AgoraView</a></h4>
- </li>
- </ul>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group tsd-is-inherited">
- <h2>Properties</h2>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="context" class="tsd-anchor"></a>
- <h3>context</h3>
- <div class="tsd-signature tsd-kind-icon">context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
- <aside class="tsd-sources">
- <p>Inherited from Component.context</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:404</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>If using the new style context, re-declare this in your class to be the
- <code>React.ContextType</code> of your <code>static contextType</code>.</p>
- </div>
- <pre><code class="language-ts"><span class="hljs-keyword">static</span> contextType = MyContext
- context!: React.ContextType<<span class="hljs-keyword">typeof</span> MyContext></code></pre>
- <dl class="tsd-comment-tags">
- <dt>deprecated</dt>
- <dd><p>if used without a type annotation, or without static contextType</p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/docs/legacy-context.html">https://reactjs.org/docs/legacy-context.html</a></p>
- </dd>
- </dl>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="props" class="tsd-anchor"></a>
- <h3>props</h3>
- <div class="tsd-signature tsd-kind-icon">props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithChildren</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- <p>Inherited from Component.props</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:429</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="refs" class="tsd-anchor"></a>
- <h3>refs</h3>
- <div class="tsd-signature tsd-kind-icon">refs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
- <aside class="tsd-sources">
- <p>Inherited from Component.refs</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:435</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <dl class="tsd-comment-tags">
- <dt>deprecated</dt>
- <dd><p><a href="https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs">https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</a></p>
- </dd>
- </dl>
- </div>
- <div class="tsd-type-declaration">
- <h4>Type declaration</h4>
- <ul class="tsd-parameters">
- <li class="tsd-parameter-index-signature">
- <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">ReactInstance</span></h5>
- </li>
- </ul>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="state" class="tsd-anchor"></a>
- <h3>state</h3>
- <div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- <p>Inherited from Component.state</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:430</li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static">
- <a name="contexttype" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> context<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">context<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- <p>Inherited from Component.contextType</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:389</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>If set, <code>this.context</code> will be set at runtime to the current value of the given Context.</p>
- </div>
- <p>Usage:</p>
- <pre><code class="language-ts">type MyContext = number
- const Ctx = React.createContext<MyContext>(0)
-
- class Foo extends React.Component {
- static contextType = Ctx
- context!: React.ContextType<typeof Ctx>
- render () {
- return <>My context's value: {this.context}</>;
- }
- }</code></pre>
- <dl class="tsd-comment-tags">
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/docs/context.html#classcontexttype">https://reactjs.org/docs/context.html#classcontexttype</a></p>
- </dd>
- </dl>
- </div>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Methods</h2>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="unsafe_componentwillmount" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Mount</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Mount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:617</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Called immediately before mounting occurs, and before <code>Component#render</code>.
- Avoid introducing any side-effects or subscriptions in this method.</p>
- </div>
- <p>This method will not stop working in React 17.</p>
- <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
- prevents this from being invoked.</p>
- <dl class="tsd-comment-tags">
- <dt>deprecated</dt>
- <dd><p>16.3, use componentDidMount or the constructor instead</p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</a></p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="unsafe_componentwillreceiveprops" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:649</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Called when the component may be receiving new props.
- React may call this even if props have not changed, so be sure to compare new and existing
- props if you only want to handle changes.</p>
- </div>
- <p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
- <p>This method will not stop working in React 17.</p>
- <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
- prevents this from being invoked.</p>
- <dl class="tsd-comment-tags">
- <dt>deprecated</dt>
- <dd><p>16.3, use static getDerivedStateFromProps instead</p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</a></p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- <li>
- <h5>nextContext: <span class="tsd-signature-type">any</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="unsafe_componentwillupdate" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Update</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Update<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span>, nextState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:677</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
- </div>
- <p>Note: You cannot call <code>Component#setState</code> here.</p>
- <p>This method will not stop working in React 17.</p>
- <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
- prevents this from being invoked.</p>
- <dl class="tsd-comment-tags">
- <dt>deprecated</dt>
- <dd><p>16.3, use getSnapshotBeforeUpdate instead</p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</a></p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- <li>
- <h5>nextState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- <li>
- <h5>nextContext: <span class="tsd-signature-type">any</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="componentdidcatch" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr>Catch</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">component<wbr>Did<wbr>Catch<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, errorInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ErrorInfo</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from ComponentLifecycle.componentDidCatch</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:546</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
- the entire component tree to unmount.</p>
- </div>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>error: <span class="tsd-signature-type">Error</span></h5>
- </li>
- <li>
- <h5>errorInfo: <span class="tsd-signature-type">ErrorInfo</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="componentdidmount" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr>Mount</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">component<wbr>Did<wbr>Mount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from ComponentLifecycle.componentDidMount</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:525</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Called immediately after a component is mounted. Setting state here will trigger re-rendering.</p>
- </div>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="componentdidupdate" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr>Update</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">component<wbr>Did<wbr>Update<span class="tsd-signature-symbol">(</span>prevProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span>, prevState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span>, snapshot<span class="tsd-signature-symbol">?: </span><a href="" class="tsd-signature-type">SS</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from NewLifecycle.componentDidUpdate</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:588</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Called immediately after updating occurs. Not called for the initial render.</p>
- </div>
- <p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>prevProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- <li>
- <h5>prevState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- <li>
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> snapshot: <a href="" class="tsd-signature-type">SS</a></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="componentwillmount" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Mount</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">component<wbr>Will<wbr>Mount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from DeprecatedLifecycle.componentWillMount</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:603</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Called immediately before mounting occurs, and before <code>Component#render</code>.
- Avoid introducing any side-effects or subscriptions in this method.</p>
- </div>
- <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
- prevents this from being invoked.</p>
- <dl class="tsd-comment-tags">
- <dt>deprecated</dt>
- <dd><p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</a></p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="componentwillreceiveprops" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Receive<wbr>Props</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">component<wbr>Will<wbr>Receive<wbr>Props<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from DeprecatedLifecycle.componentWillReceiveProps</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:632</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Called when the component may be receiving new props.
- React may call this even if props have not changed, so be sure to compare new and existing
- props if you only want to handle changes.</p>
- </div>
- <p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
- <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
- prevents this from being invoked.</p>
- <dl class="tsd-comment-tags">
- <dt>deprecated</dt>
- <dd><p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</a></p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- <li>
- <h5>nextContext: <span class="tsd-signature-type">any</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="componentwillunmount" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Unmount</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">component<wbr>Will<wbr>Unmount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from ComponentLifecycle.componentWillUnmount</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:541</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
- cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>
- </div>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="componentwillupdate" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Update</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">component<wbr>Will<wbr>Update<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span>, nextState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from DeprecatedLifecycle.componentWillUpdate</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:662</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
- </div>
- <p>Note: You cannot call <code>Component#setState</code> here.</p>
- <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
- prevents this from being invoked.</p>
- <dl class="tsd-comment-tags">
- <dt>deprecated</dt>
- <dd><p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</a></p>
- </dd>
- <dt>see</dt>
- <dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- <li>
- <h5>nextState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- <li>
- <h5>nextContext: <span class="tsd-signature-type">any</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="forceupdate" class="tsd-anchor"></a>
- <h3>force<wbr>Update</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">force<wbr>Update<span class="tsd-signature-symbol">(</span>callBack<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from Component.forceUpdate</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:421</li>
- </ul>
- </aside>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> callBack: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
- <a name="gethtmlprops" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> getHTMLProps</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
- <li class="tsd-signature tsd-kind-icon">getHTMLProps<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AgoraViewProps</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/AgoraView.native.tsx#L42">AgoraView.native.tsx:42</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>getHTMLProps</p>
- </div>
- <p>get agora view props</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AgoraViewProps</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="getsnapshotbeforeupdate" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr>Snapshot<wbr>Before<wbr>Update</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Snapshot<wbr>Before<wbr>Update<span class="tsd-signature-symbol">(</span>prevProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span>, prevState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SS</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from NewLifecycle.getSnapshotBeforeUpdate</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:582</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Runs before React applies the result of <code>render</code> to the document, and
- returns an object to be given to componentDidUpdate. Useful for saving
- things such as scroll position before <code>render</code> causes changes to it.</p>
- </div>
- <p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
- lifecycle events from running.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>prevProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- <li>
- <h5>prevState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SS</span>
- <span class="tsd-signature-symbol"> | </span>
- <span class="tsd-signature-type">null</span>
- </h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
- <a name="render" class="tsd-anchor"></a>
- <h3>render</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
- <li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Overrides Component.render</p>
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/AgoraView.native.tsx#L31">AgoraView.native.tsx:31</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>render</p>
- </div>
- <p>It would render view for VideoStream</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <a name="setstate" class="tsd-anchor"></a>
- <h3>set<wbr>State</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">set<wbr>State<K><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from Component.setState</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:416</li>
- </ul>
- </aside>
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
- <ul class="tsd-type-parameters">
- <li>
- <h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">keyof S</span></h4>
- </li>
- </ul>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>state: <span class="tsd-signature-type">function</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></h5>
- </li>
- <li>
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="shouldcomponentupdate" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> should<wbr>Component<wbr>Update</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">should<wbr>Component<wbr>Update<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span>, nextState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from ComponentLifecycle.shouldComponentUpdate</p>
- <ul>
- <li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:536</li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Called to determine whether the change in props and state should trigger a re-render.</p>
- </div>
- <p><code>Component</code> always returns true.
- <code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
- props or states have changed.</p>
- <p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>
- and <code>componentDidUpdate</code> will not be called.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- <li>
- <h5>nextState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">></span></h5>
- </li>
- <li>
- <h5>nextContext: <span class="tsd-signature-type">any</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
- </li>
- </ul>
- </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>
- </ul>
- </nav>
- <nav class="tsd-navigation secondary menu-sticky">
- <ul class="before-current">
- </ul>
- <ul class="current">
- <li class="current tsd-kind-class tsd-has-type-parameter">
- <a href="agoraview.html" class="tsd-kind-icon">Agora<wbr>View</a>
- <ul>
- <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#constructor" class="tsd-kind-icon">constructor</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#context" class="tsd-kind-icon">context</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#props" class="tsd-kind-icon">props</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#refs" class="tsd-kind-icon">refs</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#state" class="tsd-kind-icon">state</a>
- </li>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static">
- <a href="agoraview.html#contexttype" class="tsd-kind-icon">context<wbr>Type</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#unsafe_componentwillmount" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Mount</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#unsafe_componentwillreceiveprops" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#unsafe_componentwillupdate" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Update</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#componentdidcatch" class="tsd-kind-icon">component<wbr>Did<wbr>Catch</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#componentdidmount" class="tsd-kind-icon">component<wbr>Did<wbr>Mount</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#componentdidupdate" class="tsd-kind-icon">component<wbr>Did<wbr>Update</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#componentwillmount" class="tsd-kind-icon">component<wbr>Will<wbr>Mount</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#componentwillreceiveprops" class="tsd-kind-icon">component<wbr>Will<wbr>Receive<wbr>Props</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#componentwillunmount" class="tsd-kind-icon">component<wbr>Will<wbr>Unmount</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#componentwillupdate" class="tsd-kind-icon">component<wbr>Will<wbr>Update</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#forceupdate" class="tsd-kind-icon">force<wbr>Update</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
- <a href="agoraview.html#gethtmlprops" class="tsd-kind-icon">getHTMLProps</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#getsnapshotbeforeupdate" class="tsd-kind-icon">get<wbr>Snapshot<wbr>Before<wbr>Update</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
- <a href="agoraview.html#render" class="tsd-kind-icon">render</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <a href="agoraview.html#setstate" class="tsd-kind-icon">set<wbr>State</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="agoraview.html#shouldcomponentupdate" class="tsd-kind-icon">should<wbr>Component<wbr>Update</a>
- </li>
- </ul>
- </li>
- </ul>
- <ul class="after-current">
- <li class=" tsd-kind-class">
- <a href="rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
- </li>
- <li class=" tsd-kind-variable tsd-is-not-exported">
- <a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>
- </li>
- <li class=" tsd-kind-variable tsd-is-not-exported">
- <a href="../globals.html#agoraeventemitter" class="tsd-kind-icon">Agora<wbr>Event<wbr>Emitter</a>
- </li>
- <li class=" tsd-kind-variable tsd-is-not-exported">
- <a href="../globals.html#rctagoraview" class="tsd-kind-icon">RCTAgora<wbr>View</a>
- </li>
- </ul>
- </nav>
- </div>
- </div>
- </div>
- <footer class="with-border-bottom">
- <div class="container">
- <h2>Legend</h2>
- <div class="tsd-legend-group">
- <ul class="tsd-legend">
- <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
- <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
- <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
- <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
- <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
- <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
- <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
- <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
- <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
- </ul>
- </div>
- </div>
- </footer>
- <div class="container tsd-generator">
- <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
- </div>
- <div class="overlay"></div>
- <script src="../assets/js/main.js"></script>
- <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
- </body>
- </html>
|