Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AS3 Reference Documentation updates #148

Merged
merged 1 commit into from
Jan 16, 2025
Merged

AS3 Reference Documentation updates #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 39 additions & 13 deletions static/reference/actionscript/3.0/Function.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="style.css" type="text/css" media="screen">
<link rel="stylesheet" href="print.css" type="text/css" media="print">
<meta content="Function,declaration,apply,call" name="keywords">
<meta content="Function,declaration,length,apply,call" name="keywords">
<title>Function (ActionScript 3.0)</title>
<script type="text/javascript" src="AC_OETags.js"></script>
</head>
<body>
<script type="text/javascript" language="javascript" src="asdoc.js"></script><script type="text/javascript" language="javascript" src="cookies.js"></script><script type="text/javascript" language="javascript">
<!--
asdocTitle = 'Function - ActionScript 3.0 Language Reference';
var baseRef = '';
window.onload = configPage;
<!--
asdocTitle = 'Function - ActionScript 3.0 Language Reference';
var baseRef = '';
window.onload = configPage;
--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
Expand All @@ -28,8 +28,8 @@
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class Function"); titleBar_setSubNav(false,true,false,false,false,false,true,true,false,false,false,false,false,false);}
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class Function"); titleBar_setSubNav(false,true,false,false,false,false,true,true,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
Expand Down Expand Up @@ -108,6 +108,13 @@
Returns a string representing the function declaration from the source code.</div>
</td><td class="summaryTableOwnerCol">Function</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#length">length</a> : <a href="int.html">int</a>
<div class="summaryTableDescription">[read-only]

Returns the length of the argument list for this method.</div>
</td><td class="summaryTableOwnerCol">Function</td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Object.html#prototype">prototype</a> : <a href="Object.html">Object</a>
<div class="summaryTableDescription">[static]
Expand Down Expand Up @@ -227,8 +234,8 @@
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
Expand All @@ -253,6 +260,26 @@
<code>&nbsp;&nbsp;&nbsp;&nbsp;<a href="statements.html#AS3">AS3</a> function get declaration():<a href="String.html">String</a></code>
<br>
</div>
<a name="length"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">length</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>length:<a href="int.html">int</a></code>&nbsp;&nbsp;[read-only]<p>

Returns the length of the argument list for this method.

</p><p>This can be used to find out how many parameters are expected when calling this function,

excluding the <code>thisArg</code> value.</p>

<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get length():<a href="int.html">int</a></code>
<br>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="apply()"></a>
Expand Down Expand Up @@ -574,11 +601,10 @@
<p></p>
<div class="feedbackLink">
<center>
<a href="mailto:[email protected]?subject=ASLR Feedback(Mon Feb 26 2024, 5:22 PM GMT) : Function">Submit Feedback</a>
<a href="mailto:[email protected]?subject=ASLR Feedback(Sat Jan 11 2025, 8:30 AM GMT) : Function">Submit Feedback</a>
</center>
</div>
<center class="copyright"> &copy; 2004-2022 Adobe Systems Incorporated. All rights reserved. <br>Mon Feb 26 2024, 5:22 PM GMT<br> <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/80x15.png" /></a> </center>
<center class="copyright"> &copy; 2004-2022 Adobe Systems Incorporated. All rights reserved. <br>Sat Jan 11 2025, 8:30 AM GMT<br> <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/80x15.png" /></a> </center>
</div>
</body>
</html>
<!-- &copy; 2004-2022 Adobe Systems Incorporated. All rights reserved. Mon Feb 26 2024, 5:22 PM GMT <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/80x15.png" /></a> -->
</html><!-- &copy; 2004-2022 Adobe Systems Incorporated. All rights reserved. Sat Jan 11 2025, 8:30 AM GMT <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/80x15.png" /></a> -->
158 changes: 138 additions & 20 deletions static/reference/actionscript/3.0/air/net/WebSocket.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
asdocTitle = 'WebSocket - ActionScript 3.0 Language Reference';
var baseRef = '../../';
window.onload = configPage;
<!--
asdocTitle = 'WebSocket - ActionScript 3.0 Language Reference';
var baseRef = '../../';
window.onload = configPage;
--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
Expand All @@ -27,8 +27,8 @@
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class WebSocket"); titleBar_setSubNav(true,true,false,false,true,false,true,false,false,false,false,false,false,false);}
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class WebSocket"); titleBar_setSubNav(true,true,false,false,true,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
Expand Down Expand Up @@ -356,6 +356,15 @@
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:certificateError">certificateError</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">

Dispatched if there is a certificate error when trying to open a WebSocket connection.</td><td class="summaryTableOwnerCol">WebSocket</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:close">close</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
Expand All @@ -365,7 +374,7 @@
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:connected">connected</a>
<a class="signatureLink" href="#event:connect">connect</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">

Expand Down Expand Up @@ -449,8 +458,8 @@
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
Expand Down Expand Up @@ -776,10 +785,73 @@
</table>
</div>
<div class="detailSectionHeader">Event detail</div>
<a name="event:certificateError"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">certificateError</td><td class="detailHeaderType">event&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="../../flash/events/SecurityErrorEvent.html"><code>flash.events.SecurityErrorEvent</code></a>
<br>
<span class="label">SecurityErrorEvent.type property = </span><a href="../../flash/events/SecurityErrorEvent.html#CERTIFICATE_ERROR"><code>flash.events.SecurityErrorEvent.CERTIFICATE_ERROR</code></a>
<br>
<p></p>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td valign="top" style="white-space:nowrap"><b>Language version:&nbsp;</b></td><td>ActionScript 3.0
</td>
</tr>
</table>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td valign="top" style="white-space:nowrap"><b>Runtime version:&nbsp;</b></td><td>AIR&nbsp;51.0

</td>
</tr>
</table>
<p></p><p>

Dispatched if there is a certificate error when trying to open a WebSocket connection.


</p><p>

The <code>SecurityErrorEvent.CERTIFICATE_ERROR</code> constant is used when the runtime detects a problem with a server's security certificate. This event

is then dispatched, giving the application the chance to handle this and determine whether to allow the connection or to block it (which is the default

behaviour). To allow it, call <code>preventDefault()</code> on the error object. Note that not handling this error type will result in the default operating system

behaviour - typically, a message will be displayed to the end user to allow them to choose the action.


</p><p>This event has the following properties:</p>

<table class="innertable" width="100%">

<tr><th>Property</th><th>Value</th></tr>

<tr><td><code>bubbles</code></td><td><code>false</code></td></tr>

<tr><td><code>cancelable</code></td><td><code>true</code>; default behavior is to close the connection, use <code>preventDefault()</code> to allow it.</td></tr>

<tr><td><code>currentTarget</code></td><td>The object that is actively processing the Event

object with an event listener.</td></tr>

<tr><td><code>target</code></td><td>The network object reporting the security error.</td></tr>

<tr><td><code>text</code></td><td>Text to be displayed as an error message.</td></tr>

</table>


</div>
<a name="event:close"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">close</td><td class="detailHeaderType">event&nbsp;</td>
<td class="detailHeaderName">close</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
Expand Down Expand Up @@ -823,16 +895,17 @@
</table>

</div>
<a name="event:connected"></a>
<a name="event:connect"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">connected</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
<td class="detailHeaderName">connect</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="../../flash/events/Event.html"><code>flash.events.Event</code></a>
<br>
<p></p>
<span class="label">Event.type property = </span><a href="../../flash/events/Event.html#CONNECT"><code>flash.events.Event.CONNECT</code></a>
<br>
<p></p>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
Expand All @@ -852,7 +925,20 @@
Dispatched when a client WebSocket is connected (following successful handshake).


</p></div>
</p><p>
The <code>Event.CONNECT</code> constant defines the value of the <code>type</code> property of a <code>connect</code> event object.

</p><p>This event has the following properties:</p>
<table class="innertable" width="100%">
<tr><th>Property</th><th>Value</th></tr>
<tr><td><code>bubbles</code></td><td><code>false</code></td></tr>
<tr><td><code>cancelable</code></td><td><code>false</code>; there is no default behavior to cancel.</td></tr>
<tr><td><code>currentTarget</code></td><td>The object that is actively processing the Event
object with an event listener.</td></tr>
<tr><td><code>target</code></td><td>The Socket or XMLSocket object that has established a network connection.</td></tr>
</table>

</div>
<a name="event:ioError"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
Expand Down Expand Up @@ -966,7 +1052,8 @@
<div class="detailBody">
<span class="label">Event object type: </span><a href="../../flash/events/WebSocketEvent.html"><code>flash.events.WebSocketEvent</code></a>
<br>
<p></p>
<span class="label">WebSocketEvent.type property = </span><a href="../../flash/events/WebSocketEvent.html#DATA"><code>flash.events.WebSocketEvent.DATA</code></a>
<br>
<p></p>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
Expand All @@ -986,7 +1073,39 @@
Dispatched when the WebSocket receives a message.


</p></div>
</p><p>

The <code>WebSocketEvent.DATA</code> constant is used when a complete message has been received by a WebSocket object.

The event type and (if any) the message data is then provided by the event object.


</p><p>This event has the following properties:</p>

<table class="innertable" width="100%">

<tr><th>Property</th><th>Value</th></tr>

<tr><td><code>bubbles</code></td><td><code>false</code></td></tr>

<tr><td><code>cancelable</code></td><td><code>false</code>; there is no default behavior to cancel.</td></tr>

<tr><td><code>currentTarget</code></td><td>The object that is actively processing the Event

object with an event listener.</td></tr>

<tr><td><code>target</code></td><td>The network object reporting the security error.</td></tr>

<tr><td><code>format</code></td><td>The format of the WebSocket message ('TEXT', 'BINARY' etc).</td></tr>

<tr><td><code>data</code></td><td>The message data as a <code>ByteArray</code>.</td></tr>

<tr><td><code>stringData</code></td><td>The message data as a string, for 'TEXT' messages.</td></tr>

</table>


</div>
<a name="constantDetail"></a>
<div class="detailSectionHeader">Constant detail</div>
<a name="fmtBINARY"></a>
Expand Down Expand Up @@ -1131,11 +1250,10 @@
<p></p>
<div class="feedbackLink">
<center>
<a href="mailto:[email protected]?subject=ASLR Feedback(Thu Mar 21 2024, 10:06 AM GMT) : air.net.WebSocket">Submit Feedback</a>
<a href="mailto:[email protected]?subject=ASLR Feedback(Sat Jan 11 2025, 8:30 AM GMT) : air.net.WebSocket">Submit Feedback</a>
</center>
</div>
<center class="copyright"> &copy; 2004-2022 Adobe Systems Incorporated. All rights reserved. <br>Thu Mar 21 2024, 10:06 AM GMT<br> <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/80x15.png" /></a> </center>
<center class="copyright"> &copy; 2004-2022 Adobe Systems Incorporated. All rights reserved. <br>Sat Jan 11 2025, 8:30 AM GMT<br> <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/80x15.png" /></a> </center>
</div>
</body>
</html>
<!-- &copy; 2004-2022 Adobe Systems Incorporated. All rights reserved. Thu Mar 21 2024, 10:06 AM GMT <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/80x15.png" /></a> -->
</html><!-- &copy; 2004-2022 Adobe Systems Incorporated. All rights reserved. Sat Jan 11 2025, 8:30 AM GMT <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/80x15.png" /></a> -->
Loading
Loading