Skip to content

Commit da4aa36

Browse files
marchboldmarchbold
authored
Merge pull request #148 from ajwfrost/feature/air-51.1.3.4-asdocs
AS3 Reference Documentation updates
2 parents bdd95cf + 5825904 commit da4aa36

15 files changed

+2350
-340
lines changed

‎static/reference/actionscript/3.0/Function.html

+39-13
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@
55
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
66
<link rel="stylesheet" href="style.css" type="text/css" media="screen">
77
<link rel="stylesheet" href="print.css" type="text/css" media="print">
8-
<meta content="Function,declaration,apply,call" name="keywords">
8+
<meta content="Function,declaration,length,apply,call" name="keywords">
99
<title>Function (ActionScript 3.0)</title>
1010
<script type="text/javascript" src="AC_OETags.js"></script>
1111
</head>
1212
<body>
1313
<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">
14-
<!--
15-
asdocTitle = 'Function - ActionScript 3.0 Language Reference';
16-
var baseRef = '';
17-
window.onload = configPage;
14+
<!--
15+
asdocTitle = 'Function - ActionScript 3.0 Language Reference';
16+
var baseRef = '';
17+
window.onload = configPage;
1818
--></script>
1919
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
2020
<tr>
@@ -28,8 +28,8 @@
2828
</tr>
2929
</table>
3030
<script type="text/javascript" language="javascript">
31-
<!--
32-
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);}
31+
<!--
32+
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);}
3333
--></script>
3434
<div class="MainContent">
3535
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
@@ -108,6 +108,13 @@
108108
Returns a string representing the function declaration from the source code.</div>
109109
</td><td class="summaryTableOwnerCol">Function</td>
110110
</tr>
111+
<tr class="">
112+
<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>
113+
<div class="summaryTableDescription">[read-only]
114+
115+
Returns the length of the argument list for this method.</div>
116+
</td><td class="summaryTableOwnerCol">Function</td>
117+
</tr>
111118
<tr class="hideInheritedProperty">
112119
<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>
113120
<div class="summaryTableDescription">[static]
@@ -227,8 +234,8 @@
227234
</table>
228235
</div>
229236
<script type="text/javascript" language="javascript">
230-
<!--
231-
showHideInherited();
237+
<!--
238+
showHideInherited();
232239
--></script>
233240
<div class="MainContent">
234241
<a name="propertyDetail"></a>
@@ -253,6 +260,26 @@
253260
<code>&nbsp;&nbsp;&nbsp;&nbsp;<a href="statements.html#AS3">AS3</a> function get declaration():<a href="String.html">String</a></code>
254261
<br>
255262
</div>
263+
<a name="length"></a>
264+
<table cellspacing="0" cellpadding="0" class="detailHeader">
265+
<tr>
266+
<td class="detailHeaderName">length</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
267+
</tr>
268+
</table>
269+
<div class="detailBody">
270+
<code>length:<a href="int.html">int</a></code>&nbsp;&nbsp;[read-only]<p>
271+
272+
Returns the length of the argument list for this method.
273+
274+
</p><p>This can be used to find out how many parameters are expected when calling this function,
275+
276+
excluding the <code>thisArg</code> value.</p>
277+
278+
<span class="label">Implementation</span>
279+
<br>
280+
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get length():<a href="int.html">int</a></code>
281+
<br>
282+
</div>
256283
<a name="methodDetail"></a>
257284
<div class="detailSectionHeader">Method detail</div>
258285
<a name="apply()"></a>
@@ -574,11 +601,10 @@
574601
<p></p>
575602
<div class="feedbackLink">
576603
<center>
577-
<a href="mailto:[email protected]?subject=ASLR Feedback(Mon Feb 26 2024, 5:22 PM GMT) : Function">Submit Feedback</a>
604+
<a href="mailto:[email protected]?subject=ASLR Feedback(Sat Jan 11 2025, 8:30 AM GMT) : Function">Submit Feedback</a>
578605
</center>
579606
</div>
580-
<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>
607+
<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>
581608
</div>
582609
</body>
583-
</html>
584-
<!-- &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> -->
610+
</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> -->

‎static/reference/actionscript/3.0/air/net/WebSocket.html

+138-20
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
</head>
1111
<body>
1212
<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">
13-
<!--
14-
asdocTitle = 'WebSocket - ActionScript 3.0 Language Reference';
15-
var baseRef = '../../';
16-
window.onload = configPage;
13+
<!--
14+
asdocTitle = 'WebSocket - ActionScript 3.0 Language Reference';
15+
var baseRef = '../../';
16+
window.onload = configPage;
1717
--></script>
1818
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
1919
<tr>
@@ -27,8 +27,8 @@
2727
</tr>
2828
</table>
2929
<script type="text/javascript" language="javascript">
30-
<!--
31-
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);}
30+
<!--
31+
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);}
3232
--></script>
3333
<div class="MainContent">
3434
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
@@ -356,6 +356,15 @@
356356
<tr class="">
357357
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
358358
<div class="summarySignature">
359+
<a class="signatureLink" href="#event:certificateError">certificateError</a>
360+
</div>
361+
</td><td class="summaryTableDescription summaryTableCol">
362+
363+
Dispatched if there is a certificate error when trying to open a WebSocket connection.</td><td class="summaryTableOwnerCol">WebSocket</td>
364+
</tr>
365+
<tr class="">
366+
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
367+
<div class="summarySignature">
359368
<a class="signatureLink" href="#event:close">close</a>
360369
</div>
361370
</td><td class="summaryTableDescription summaryTableCol">
@@ -365,7 +374,7 @@
365374
<tr class="">
366375
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
367376
<div class="summarySignature">
368-
<a class="signatureLink" href="#event:connected">connected</a>
377+
<a class="signatureLink" href="#event:connect">connect</a>
369378
</div>
370379
</td><td class="summaryTableDescription summaryTableCol">
371380

@@ -449,8 +458,8 @@
449458
</table>
450459
</div>
451460
<script type="text/javascript" language="javascript">
452-
<!--
453-
showHideInherited();
461+
<!--
462+
showHideInherited();
454463
--></script>
455464
<div class="MainContent">
456465
<a name="propertyDetail"></a>
@@ -776,10 +785,73 @@
776785
</table>
777786
</div>
778787
<div class="detailSectionHeader">Event detail</div>
788+
<a name="event:certificateError"></a>
789+
<table cellspacing="0" cellpadding="0" class="detailHeader">
790+
<tr>
791+
<td class="detailHeaderName">certificateError</td><td class="detailHeaderType">event&nbsp;</td>
792+
</tr>
793+
</table>
794+
<div class="detailBody">
795+
<span class="label">Event object type: </span><a href="../../flash/events/SecurityErrorEvent.html"><code>flash.events.SecurityErrorEvent</code></a>
796+
<br>
797+
<span class="label">SecurityErrorEvent.type property = </span><a href="../../flash/events/SecurityErrorEvent.html#CERTIFICATE_ERROR"><code>flash.events.SecurityErrorEvent.CERTIFICATE_ERROR</code></a>
798+
<br>
799+
<p></p>
800+
<table border="0" cellspacing="0" cellpadding="0">
801+
<tr>
802+
<td valign="top" style="white-space:nowrap"><b>Language version:&nbsp;</b></td><td>ActionScript 3.0
803+
</td>
804+
</tr>
805+
</table>
806+
<table border="0" cellspacing="0" cellpadding="0">
807+
<tr>
808+
<td valign="top" style="white-space:nowrap"><b>Runtime version:&nbsp;</b></td><td>AIR&nbsp;51.0
809+
810+
</td>
811+
</tr>
812+
</table>
813+
<p></p><p>
814+
815+
Dispatched if there is a certificate error when trying to open a WebSocket connection.
816+
817+
818+
</p><p>
819+
820+
The <code>SecurityErrorEvent.CERTIFICATE_ERROR</code> constant is used when the runtime detects a problem with a server's security certificate. This event
821+
822+
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
823+
824+
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
825+
826+
behaviour - typically, a message will be displayed to the end user to allow them to choose the action.
827+
828+
829+
</p><p>This event has the following properties:</p>
830+
831+
<table class="innertable" width="100%">
832+
833+
<tr><th>Property</th><th>Value</th></tr>
834+
835+
<tr><td><code>bubbles</code></td><td><code>false</code></td></tr>
836+
837+
<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>
838+
839+
<tr><td><code>currentTarget</code></td><td>The object that is actively processing the Event
840+
841+
object with an event listener.</td></tr>
842+
843+
<tr><td><code>target</code></td><td>The network object reporting the security error.</td></tr>
844+
845+
<tr><td><code>text</code></td><td>Text to be displayed as an error message.</td></tr>
846+
847+
</table>
848+
849+
850+
</div>
779851
<a name="event:close"></a>
780852
<table cellspacing="0" cellpadding="0" class="detailHeader">
781853
<tr>
782-
<td class="detailHeaderName">close</td><td class="detailHeaderType">event&nbsp;</td>
854+
<td class="detailHeaderName">close</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
783855
</tr>
784856
</table>
785857
<div class="detailBody">
@@ -823,16 +895,17 @@
823895
</table>
824896

825897
</div>
826-
<a name="event:connected"></a>
898+
<a name="event:connect"></a>
827899
<table cellspacing="0" cellpadding="0" class="detailHeader">
828900
<tr>
829-
<td class="detailHeaderName">connected</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
901+
<td class="detailHeaderName">connect</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
830902
</tr>
831903
</table>
832904
<div class="detailBody">
833905
<span class="label">Event object type: </span><a href="../../flash/events/Event.html"><code>flash.events.Event</code></a>
834906
<br>
835-
<p></p>
907+
<span class="label">Event.type property = </span><a href="../../flash/events/Event.html#CONNECT"><code>flash.events.Event.CONNECT</code></a>
908+
<br>
836909
<p></p>
837910
<table border="0" cellspacing="0" cellpadding="0">
838911
<tr>
@@ -852,7 +925,20 @@
852925
Dispatched when a client WebSocket is connected (following successful handshake).
853926

854927

855-
</p></div>
928+
</p><p>
929+
The <code>Event.CONNECT</code> constant defines the value of the <code>type</code> property of a <code>connect</code> event object.
930+
931+
</p><p>This event has the following properties:</p>
932+
<table class="innertable" width="100%">
933+
<tr><th>Property</th><th>Value</th></tr>
934+
<tr><td><code>bubbles</code></td><td><code>false</code></td></tr>
935+
<tr><td><code>cancelable</code></td><td><code>false</code>; there is no default behavior to cancel.</td></tr>
936+
<tr><td><code>currentTarget</code></td><td>The object that is actively processing the Event
937+
object with an event listener.</td></tr>
938+
<tr><td><code>target</code></td><td>The Socket or XMLSocket object that has established a network connection.</td></tr>
939+
</table>
940+
941+
</div>
856942
<a name="event:ioError"></a>
857943
<table cellspacing="0" cellpadding="0" class="detailHeader">
858944
<tr>
@@ -966,7 +1052,8 @@
9661052
<div class="detailBody">
9671053
<span class="label">Event object type: </span><a href="../../flash/events/WebSocketEvent.html"><code>flash.events.WebSocketEvent</code></a>
9681054
<br>
969-
<p></p>
1055+
<span class="label">WebSocketEvent.type property = </span><a href="../../flash/events/WebSocketEvent.html#DATA"><code>flash.events.WebSocketEvent.DATA</code></a>
1056+
<br>
9701057
<p></p>
9711058
<table border="0" cellspacing="0" cellpadding="0">
9721059
<tr>
@@ -986,7 +1073,39 @@
9861073
Dispatched when the WebSocket receives a message.
9871074

9881075

989-
</p></div>
1076+
</p><p>
1077+
1078+
The <code>WebSocketEvent.DATA</code> constant is used when a complete message has been received by a WebSocket object.
1079+
1080+
The event type and (if any) the message data is then provided by the event object.
1081+
1082+
1083+
</p><p>This event has the following properties:</p>
1084+
1085+
<table class="innertable" width="100%">
1086+
1087+
<tr><th>Property</th><th>Value</th></tr>
1088+
1089+
<tr><td><code>bubbles</code></td><td><code>false</code></td></tr>
1090+
1091+
<tr><td><code>cancelable</code></td><td><code>false</code>; there is no default behavior to cancel.</td></tr>
1092+
1093+
<tr><td><code>currentTarget</code></td><td>The object that is actively processing the Event
1094+
1095+
object with an event listener.</td></tr>
1096+
1097+
<tr><td><code>target</code></td><td>The network object reporting the security error.</td></tr>
1098+
1099+
<tr><td><code>format</code></td><td>The format of the WebSocket message ('TEXT', 'BINARY' etc).</td></tr>
1100+
1101+
<tr><td><code>data</code></td><td>The message data as a <code>ByteArray</code>.</td></tr>
1102+
1103+
<tr><td><code>stringData</code></td><td>The message data as a string, for 'TEXT' messages.</td></tr>
1104+
1105+
</table>
1106+
1107+
1108+
</div>
9901109
<a name="constantDetail"></a>
9911110
<div class="detailSectionHeader">Constant detail</div>
9921111
<a name="fmtBINARY"></a>
@@ -1131,11 +1250,10 @@
11311250
<p></p>
11321251
<div class="feedbackLink">
11331252
<center>
1134-
<a href="mailto:[email protected]?subject=ASLR Feedback(Thu Mar 21 2024, 10:06 AM GMT) : air.net.WebSocket">Submit Feedback</a>
1253+
<a href="mailto:[email protected]?subject=ASLR Feedback(Sat Jan 11 2025, 8:30 AM GMT) : air.net.WebSocket">Submit Feedback</a>
11351254
</center>
11361255
</div>
1137-
<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>
1256+
<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>
11381257
</div>
11391258
</body>
1140-
</html>
1141-
<!-- &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> -->
1259+
</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> -->

0 commit comments

Comments
 (0)