-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3842 from AgoraIO/translation/4.x-api-ref
New YiCAT updates
- Loading branch information
Showing
2 changed files
with
65 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
<reference id="api_rte_destroy"> | ||
<title><ph keyref="Destroy_Rte"/></title> | ||
<shortdesc id="short"><ph id="shortdesc">Destroys an RTE object.</ph></shortdesc> | ||
<prolog> | ||
<metadata> | ||
<keywords> | ||
<indexterm keyref="Destroy_Rte"/> | ||
</keywords> | ||
</metadata> | ||
</prolog> | ||
<refbody> | ||
<section id="prototype"> | ||
<p outputclass="codeblock"> | ||
<codeblock props="android" outputclass="language-java">public synchronized void destroy() throws RteException;</codeblock> | ||
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)destroy:(AgoraRteError * _Nullable)error;</codeblock> | ||
<codeblock props="cpp unreal" outputclass="language-cpp">bool Destroy(Error *err = nullptr){ | ||
return RteDestroy(&c_rte, err != nullptr ? err->get_underlying_impl() : nullptr); | ||
}</codeblock> | ||
<codeblock props="bp" outputclass="language-cpp"/> | ||
<codeblock props="electron" outputclass="language-typescript"/> | ||
<codeblock props="unity cs" outputclass="language-csharp"/> | ||
<codeblock props="rn" outputclass="language-typescript"/> | ||
<codeblock props="flutter" outputclass="language-dart"/> </p> | ||
</section> | ||
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title"> | ||
<dl outputclass="since"> | ||
<dlentry props="native"> | ||
<dt>Since</dt> | ||
<dd>v4.5.0</dd> | ||
</dlentry> | ||
</dl> | ||
<p>This method releases all resources used by the RTE object.</p> | ||
</section> | ||
<section id="restriction" deliveryTarget="details"> | ||
<title>Restrictions</title> | ||
<p>None.</p> | ||
</section> | ||
<section id="parameters" deliveryTarget="details"> | ||
<title><ph props="cpp apple">Parameters</ph></title> | ||
<parml props="cpp apple"> | ||
<plentry conkeyref="SetConfigs_Rte/err"> | ||
<pt/> | ||
<pd/> | ||
</plentry> | ||
</parml> </section> | ||
<section id="return_values" props="apple cpp framework"> | ||
<title><ph keyref="return-section-title"/></title> | ||
<p props="flutter">When the method call succeeds, there is no return value; when fails, the <xref keyref="AgoraRtcException"/> exception is thrown. You need to catch the exception and handle it accordingly. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></p> | ||
<p props="cpp apple unreal bp electron unity rn cs">Whether the RTE object is successfully destroyed:<ul> | ||
<li><codeph><ph keyref="true"/></codeph>: The RTE object is destroyed.</li> | ||
<li><codeph><ph keyref="false"/></codeph>: The RTE object is not destroyed.</li> | ||
</ul> | ||
</p> </section> | ||
<section props="android" conkeyref="SetAppId/exception"/> | ||
</refbody> | ||
</reference> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters