1474 lines
91 KiB
HTML
1474 lines
91 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>SharedObject | openfl</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">openfl</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="../index.html">openfl</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/openfl.net.html">net</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.net.sharedobject.html">SharedObject</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class SharedObject</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>The SharedObject class is used to read and store limited amounts of data on
|
|
a user's computer or on a server. Shared objects offer real-time data
|
|
sharing between multiple client SWF files and objects that are persistent
|
|
on the local computer or remote server. Local shared objects are similar to
|
|
browser cookies and remote shared objects are similar to real-time data
|
|
transfer devices. To use remote shared objects, you need Adobe Flash Media
|
|
Server.</p>
|
|
</div>
|
|
<p>Use shared objects to do the following:</p>
|
|
<ul>
|
|
<li><strong>Maintain local persistence</strong>. This is the simplest way to use a
|
|
shared object, and does not require Flash Media Server. For example, you
|
|
can call <code>SharedObject.getLocal()</code> to create a shared object in
|
|
an application, such as a calculator with memory. When the user closes the
|
|
calculator, Flash Player saves the last value in a shared object on the
|
|
user's computer. The next time the calculator is run, it contains the
|
|
values it had previously. Alternatively, if you set the shared object's
|
|
properties to <code>null</code> before the calculator application is
|
|
closed, the next time the application runs, it opens without any values.
|
|
Another example of maintaining local persistence is tracking user
|
|
preferences or other data for a complex website, such as a record of which
|
|
articles a user read on a news site. Tracking this information allows you
|
|
to display articles that have already been read differently from new,
|
|
unread articles. Storing this information on the user's computer reduces
|
|
server load.</li>
|
|
<li><strong>Store and share data on Flash Media Server</strong>. A shared object
|
|
can store data on the server for other clients to retrieve. For example,
|
|
call <code>SharedObject.getRemote()</code> to create a remote shared
|
|
object, such as a phone list, that is persistent on the server. Whenever a
|
|
client makes changes to the shared object, the revised data is available to
|
|
all clients currently connected to the object or who later connect to it.
|
|
If the object is also persistent locally, and a client changes data while
|
|
not connected to the server, the data is copied to the remote shared object
|
|
the next time the client connects to the object.</li>
|
|
<li><strong>Share data in real time</strong>. A shared object can share data among
|
|
multiple clients in real time. For example, you can open a remote shared
|
|
object that stores a list of users connected to a chat room that is visible
|
|
to all clients connected to the object. When a user enters or leaves the
|
|
chat room, the object is updated and all clients that are connected to the
|
|
object see the revised list of chat room users.</li>
|
|
</ul>
|
|
<p> To create a local shared object, call
|
|
<code>SharedObject.getLocal()</code>. To create a remote shared object,
|
|
call <code>SharedObject.getRemote()</code>.</p>
|
|
<p> When an application closes, shared objects are <em>flushed</em>, or
|
|
written to a disk. You can also call the <code>flush()</code> method to
|
|
explicitly write data to a disk.</p>
|
|
<p><strong>Local disk space considerations.</strong> Local shared objects have some
|
|
limitations that are important to consider as you design your application.
|
|
Sometimes SWF files may not be allowed to write local shared objects, and
|
|
sometimes the data stored in local shared objects can be deleted without
|
|
your knowledge. Flash Player users can manage the disk space that is
|
|
available to individual domains or to all domains. When users decrease the
|
|
amount of disk space available, some local shared objects may be deleted.
|
|
Flash Player users also have privacy controls that can prevent third-party
|
|
domains(domains other than the domain in the current browser address bar)
|
|
from reading or writing local shared objects.</p>
|
|
<p><strong>Note</strong>: SWF files that are stored and run on a local computer, not
|
|
from a remote server, can always write third-party shared objects to disk.
|
|
For more information about third-party shared objects, see the
|
|
<a href="http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager03.html">Global Storage Settings panel</a>
|
|
in Flash Player Help.</p>
|
|
<p>It's a good idea to check for failures related to the amount of disk
|
|
space and to user privacy controls. Perform these checks when you call
|
|
<code>getLocal()</code> and <code>flush()</code>:</p>
|
|
<ul>
|
|
<li><code>SharedObject.getLocal()</code> - Flash Player throws an
|
|
exception when a call to this method fails, such as when the user has
|
|
disabled third-party shared objects and the domain of your SWF file does
|
|
not match the domain in the browser address bar.</li>
|
|
<li><code>SharedObject.flush()</code> - Flash Player throws an
|
|
exception when a call to this method fails. It returns
|
|
<code>SharedObjectFlushStatus.FLUSHED</code> when it succeeds. It returns
|
|
<code>SharedObjectFlushStatus.PENDING</code> when additional storage space
|
|
is needed. Flash Player prompts the user to allow an increase in storage
|
|
space for locally saved information. Thereafter, the <code>netStatus</code>
|
|
event is dispatched with an information object indicating whether the flush
|
|
failed or succeeded.</li>
|
|
</ul>
|
|
<p>If your SWF file attempts to create or modify local shared objects, make
|
|
sure that your SWF file is at least 215 pixels wide and at least 138 pixels
|
|
high(the minimum dimensions for displaying the dialog box that prompts
|
|
users to increase their local shared object storage limit). If your SWF
|
|
file is smaller than these dimensions and an increase in the storage limit
|
|
is required, <code>SharedObject.flush()</code> fails, returning
|
|
<code>SharedObjectFlushedStatus.PENDING</code> and dispatching the
|
|
<code>netStatus</code> event.</p>
|
|
<p> <strong>Remote shared objects.</strong> With Flash Media Server, you can create
|
|
and use remote shared objects, that are shared in real-time by all clients
|
|
connected to your application. When one client changes a property of a
|
|
remote shared object, the property is changed for all connected clients.
|
|
You can use remote shared objects to synchronize clients, for example,
|
|
users in a multi-player game.</p>
|
|
<p> Each remote shared object has a <code>data</code> property which is an
|
|
Object with properties that store data. Call <code>setProperty()</code> to
|
|
change an property of the data object. The server updates the properties,
|
|
dispatches a <code>sync</code> event, and sends the properties back to the
|
|
connected clients.</p>
|
|
<p> You can choose to make remote shared objects persistent on the client,
|
|
the server, or both. By default, Flash Player saves locally persistent
|
|
remote shared objects up to 100K in size. When you try to save a larger
|
|
object, Flash Player displays the Local Storage dialog box, which lets the
|
|
user allow or deny local storage for the shared object. Make sure your
|
|
Stage size is at least 215 by 138 pixels; this is the minimum size Flash
|
|
requires to display the dialog box.</p>
|
|
<p> If the user selects Allow, the server saves the shared object and
|
|
dispatches a <code>netStatus</code> event with a <code>code</code> property
|
|
of <code>SharedObject.Flush.Success</code>. If the user select Deny, the
|
|
server does not save the shared object and dispatches a
|
|
<code>netStatus</code> event with a <code>code</code> property of
|
|
<code>SharedObject.Flush.Failed</code>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>:event</dt>
|
|
<dd><p>asyncError Dispatched when an exception is thrown asynchronously -
|
|
that is, from native asynchronous code.</p>
|
|
</dd>
|
|
<dt>:event</dt>
|
|
<dd><p>netStatus Dispatched when a SharedObject instance is reporting its
|
|
status or error condition. The <code>netStatus</code>
|
|
event contains an <code>info</code> property, which is an
|
|
information object that contains specific information
|
|
about the event, such as whether a connection attempt
|
|
succeeded or whether the shared object was successfully
|
|
written to the local disk.</p>
|
|
</dd>
|
|
<dt>:event</dt>
|
|
<dd><p>sync Dispatched when a remote shared object has been updated
|
|
by the server.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="openfl.events.eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">SharedObject</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implements</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="openfl.events.ieventdispatcher.html" class="tsd-signature-type">IEventDispatcher</a></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 tsd-is-external">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.net.sharedobject.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-external">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.net.sharedobject.html#client" class="tsd-kind-icon">client</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.net.sharedobject.html#data" class="tsd-kind-icon">data</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.net.sharedobject.html#fps" class="tsd-kind-icon">fps</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.net.sharedobject.html#objectencoding" class="tsd-kind-icon">object<wbr>Encoding</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.net.sharedobject.html#size" class="tsd-kind-icon">size</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.net.sharedobject.html#defaultobjectencoding" class="tsd-kind-icon">default<wbr>Object<wbr>Encoding</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-external">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.net.sharedobject.html#addeventlistener" class="tsd-kind-icon">add<wbr>Event<wbr>Listener</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.net.sharedobject.html#clear" class="tsd-kind-icon">clear</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.net.sharedobject.html#close" class="tsd-kind-icon">close</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.net.sharedobject.html#connect" class="tsd-kind-icon">connect</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.net.sharedobject.html#dispatchevent" class="tsd-kind-icon">dispatch<wbr>Event</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.net.sharedobject.html#flush" class="tsd-kind-icon">flush</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.net.sharedobject.html#haseventlistener" class="tsd-kind-icon">has<wbr>Event<wbr>Listener</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.net.sharedobject.html#removeeventlistener" class="tsd-kind-icon">remove<wbr>Event<wbr>Listener</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.net.sharedobject.html#send" class="tsd-kind-icon">send</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.net.sharedobject.html#setdirty" class="tsd-kind-icon">set<wbr>Dirty</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.net.sharedobject.html#setproperty" class="tsd-kind-icon">set<wbr>Property</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.net.sharedobject.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.net.sharedobject.html#willtrigger" class="tsd-kind-icon">will<wbr>Trigger</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.net.sharedobject.html#getlocal" class="tsd-kind-icon">get<wbr>Local</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.net.sharedobject.html#getremote" class="tsd-kind-icon">get<wbr>Remote</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Shared<wbr>Object<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">?: </span><a href="openfl.events.ieventdispatcher.html" class="tsd-signature-type">IEventDispatcher</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.net.sharedobject.html" class="tsd-signature-type">SharedObject</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#constructor">constructor</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L50">lib/openfl/events/EventDispatcher.d.ts:50</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Aggregates an instance of the EventDispatcher class.</p>
|
|
</div>
|
|
<p>The EventDispatcher class is generally used as a base class, which
|
|
means that most developers do not need to use this constructor function.
|
|
However, advanced developers who are implementing the IEventDispatcher
|
|
interface need to use this constructor. If you are unable to extend the
|
|
EventDispatcher class and must instead implement the IEventDispatcher
|
|
interface, use this constructor to aggregate an instance of the
|
|
EventDispatcher class.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> target: <a href="openfl.events.ieventdispatcher.html" class="tsd-signature-type">IEventDispatcher</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The target object for events dispatched to the
|
|
EventDispatcher object. This parameter is used when the
|
|
EventDispatcher instance is aggregated by a class that
|
|
implements IEventDispatcher; it is necessary so that the
|
|
containing object can be the target for events. Do not use
|
|
this parameter in simple cases in which a class extends
|
|
EventDispatcher.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="openfl.net.sharedobject.html" class="tsd-signature-type">SharedObject</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="client" class="tsd-anchor"></a>
|
|
<h3>client</h3>
|
|
<div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L155">lib/openfl/net/SharedObject.d.ts:155</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="data" class="tsd-anchor"></a>
|
|
<h3>data</h3>
|
|
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L170">lib/openfl/net/SharedObject.d.ts:170</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The collection of attributes assigned to the <code>data</code> property of
|
|
the object; these attributes can be shared and stored. Each attribute can
|
|
be an object of any ActionScript or JavaScript type - Array, Number,
|
|
Boolean, ByteArray, XML, and so on. For example, the following lines
|
|
assign values to various aspects of a shared object:</p>
|
|
</div>
|
|
<p> For remote shared objects used with a server, all attributes of the
|
|
<code>data</code> property are available to all clients connected to the
|
|
shared object, and all attributes are saved if the object is persistent.
|
|
If one client changes the value of an attribute, all clients now see the
|
|
new value.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="fps" class="tsd-anchor"></a>
|
|
<h3>fps</h3>
|
|
<div class="tsd-signature tsd-kind-icon">fps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L172">lib/openfl/net/SharedObject.d.ts:172</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="objectencoding" class="tsd-anchor"></a>
|
|
<h3>object<wbr>Encoding</h3>
|
|
<div class="tsd-signature tsd-kind-icon">object<wbr>Encoding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L173">lib/openfl/net/SharedObject.d.ts:173</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="size" class="tsd-anchor"></a>
|
|
<h3>size</h3>
|
|
<div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L184">lib/openfl/net/SharedObject.d.ts:184</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The current size of the shared object, in bytes.</p>
|
|
</div>
|
|
<p>Flash calculates the size of a shared object by stepping through all of
|
|
its data properties; the more data properties the object has, the longer
|
|
it takes to estimate its size. Estimating object size can take significant
|
|
processing time, so you may want to avoid using this method unless you
|
|
have a specific need for it.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="defaultobjectencoding" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> default<wbr>Object<wbr>Encoding</h3>
|
|
<div class="tsd-signature tsd-kind-icon">default<wbr>Object<wbr>Encoding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L149">lib/openfl/net/SharedObject.d.ts:149</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="addeventlistener" class="tsd-anchor"></a>
|
|
<h3>add<wbr>Event<wbr>Listener</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Event<wbr>Listener<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, useCapture<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, priority<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, useWeakReference<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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 <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#addeventlistener">addEventListener</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L168">lib/openfl/events/EventDispatcher.d.ts:168</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Registers an event listener object with an EventDispatcher object so that
|
|
the listener receives notification of an event. You can register event
|
|
listeners on all nodes in the display list for a specific type of event,
|
|
phase, and priority.</p>
|
|
</div>
|
|
<p>After you successfully register an event listener, you cannot change
|
|
its priority through additional calls to <code>addEventListener()</code>.
|
|
To change a listener's priority, you must first call
|
|
<code>removeListener()</code>. Then you can register the listener again
|
|
with the new priority level.</p>
|
|
<p>Keep in mind that after the listener is registered, subsequent calls to
|
|
<code>addEventListener()</code> with a different <code>type</code> or
|
|
<code>useCapture</code> value result in the creation of a separate
|
|
listener registration. For example, if you first register a listener with
|
|
<code>useCapture</code> set to <code>true</code>, it listens only during
|
|
the capture phase. If you call <code>addEventListener()</code> again using
|
|
the same listener object, but with <code>useCapture</code> set to
|
|
<code>false</code>, you have two separate listeners: one that listens
|
|
during the capture phase and another that listens during the target and
|
|
bubbling phases.</p>
|
|
<p>You cannot register an event listener for only the target phase or the
|
|
bubbling phase. Those phases are coupled during registration because
|
|
bubbling applies only to the ancestors of the target node.</p>
|
|
<p>If you no longer need an event listener, remove it by calling
|
|
<code>removeEventListener()</code>, or memory problems could result. Event
|
|
listeners are not automatically removed from memory because the garbage
|
|
collector does not remove the listener as long as the dispatching object
|
|
exists(unless the <code>useWeakReference</code> parameter is set to
|
|
<code>true</code>).</p>
|
|
<p>Copying an EventDispatcher instance does not copy the event listeners
|
|
attached to it.(If your newly created node needs an event listener, you
|
|
must attach the listener after creating the node.) However, if you move an
|
|
EventDispatcher instance, the event listeners attached to it move along
|
|
with it.</p>
|
|
<p>If the event listener is being registered on a node while an event is
|
|
being processed on this node, the event listener is not triggered during
|
|
the current phase but can be triggered during a later phase in the event
|
|
flow, such as the bubbling phase.</p>
|
|
<p>If an event listener is removed from a node while an event is being
|
|
processed on the node, it is still triggered by the current actions. After
|
|
it is removed, the event listener is never invoked again(unless
|
|
registered again for future processing).</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>ArgumentError The <code>listener</code> specified is not a
|
|
function.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The type of event.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>listener: <span class="tsd-signature-type">function</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-siganture">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>event: <span class="tsd-signature-type">object</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> useCapture: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Determines whether the listener works in the
|
|
capture phase or the target and bubbling phases.
|
|
If <code>useCapture</code> is set to
|
|
<code>true</code>, the listener processes the
|
|
event only during the capture phase and not in the
|
|
target or bubbling phase. If
|
|
<code>useCapture</code> is <code>false</code>, the
|
|
listener processes the event only during the
|
|
target or bubbling phase. To listen for the event
|
|
in all three phases, call
|
|
<code>addEventListener</code> twice, once with
|
|
<code>useCapture</code> set to <code>true</code>,
|
|
then again with <code>useCapture</code> set to
|
|
<code>false</code>.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> priority: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The priority level of the event listener. The
|
|
priority is designated by a signed 32-bit integer.
|
|
The higher the number, the higher the priority.
|
|
All listeners with priority <em>n</em> are processed
|
|
before listeners of priority <em>n</em>-1. If two or
|
|
more listeners share the same priority, they are
|
|
processed in the order in which they were added.
|
|
The default priority is 0.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> useWeakReference: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Determines whether the reference to the listener
|
|
is strong or weak. A strong reference(the
|
|
default) prevents your listener from being
|
|
garbage-collected. A weak reference does not.</p>
|
|
<pre><code> Class-level member functions are not subject to
|
|
garbage collection, so you can <span class="hljs-keyword">set</span>
|
|
<span class="hljs-string">`useWeakReference`</span> <span class="hljs-keyword">to</span> <span class="hljs-string">`true`</span>
|
|
<span class="hljs-keyword">for</span> <span class="hljs-keyword">class</span>-<span class="hljs-keyword">level</span> <span class="hljs-keyword">member</span> functions <span class="hljs-keyword">without</span>
|
|
subjecting them <span class="hljs-keyword">to</span> garbage collection. <span class="hljs-keyword">If</span> you <span class="hljs-keyword">set</span>
|
|
<span class="hljs-string">`useWeakReference`</span> <span class="hljs-keyword">to</span> <span class="hljs-string">`true`</span>
|
|
<span class="hljs-keyword">for</span> a listener that <span class="hljs-keyword">is</span> a <span class="hljs-keyword">nested</span> <span class="hljs-keyword">inner</span> <span class="hljs-keyword">function</span>,
|
|
the <span class="hljs-keyword">function</span> will be garbage-collected <span class="hljs-keyword">and</span> <span class="hljs-keyword">no</span>
|
|
longer persistent. <span class="hljs-keyword">If</span> you <span class="hljs-keyword">create</span> <span class="hljs-keyword">references</span> <span class="hljs-keyword">to</span> the
|
|
<span class="hljs-keyword">inner</span> <span class="hljs-keyword">function</span>(<span class="hljs-keyword">save</span> it <span class="hljs-keyword">in</span> another <span class="hljs-keyword">variable</span>) <span class="hljs-keyword">then</span>
|
|
it <span class="hljs-keyword">is</span> <span class="hljs-keyword">not</span> garbage-collected <span class="hljs-keyword">and</span> stays
|
|
persistent.
|
|
</code></pre>
|
|
</div>
|
|
</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-external">
|
|
<a name="clear" class="tsd-anchor"></a>
|
|
<h3>clear</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">clear<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">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L202">lib/openfl/net/SharedObject.d.ts:202</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>For local shared objects, purges all of the data and deletes the shared
|
|
object from the disk. The reference to the shared object is still active,
|
|
but its data properties are deleted.</p>
|
|
</div>
|
|
<p> For remote shared objects used with Flash Media Server,
|
|
<code>clear()</code> disconnects the object and purges all of the data. If
|
|
the shared object is locally persistent, this method also deletes the
|
|
shared object from the disk. The reference to the shared object is still
|
|
active, but its data properties are deleted.</p>
|
|
</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-external">
|
|
<a name="close" class="tsd-anchor"></a>
|
|
<h3>close</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">close<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">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L205">lib/openfl/net/SharedObject.d.ts:205</a></li>
|
|
</ul>
|
|
</aside>
|
|
<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-external">
|
|
<a name="connect" class="tsd-anchor"></a>
|
|
<h3>connect</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>myConnection<span class="tsd-signature-symbol">: </span><a href="openfl.net.netconnection.html" class="tsd-signature-type">NetConnection</a>, params<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</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">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L208">lib/openfl/net/SharedObject.d.ts:208</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>myConnection: <a href="openfl.net.netconnection.html" class="tsd-signature-type">NetConnection</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> params: <span class="tsd-signature-type">string</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 tsd-is-external">
|
|
<a name="dispatchevent" class="tsd-anchor"></a>
|
|
<h3>dispatch<wbr>Event</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">dispatch<wbr>Event<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="openfl.events.event.html" class="tsd-signature-type">Event</a><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 <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#dispatchevent">dispatchEvent</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L186">lib/openfl/events/EventDispatcher.d.ts:186</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Dispatches an event into the event flow. The event target is the
|
|
EventDispatcher object upon which the <code>dispatchEvent()</code> method
|
|
is called.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>Error The event dispatch recursion limit has been reached.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>event: <a href="openfl.events.event.html" class="tsd-signature-type">Event</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The Event object that is dispatched into the event flow. If
|
|
the event is being redispatched, a clone of the event is
|
|
created automatically. After an event is dispatched, its
|
|
<code>target</code> property cannot be changed, so you must
|
|
create a new copy of the event for redispatching to work.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>A value of <code>true</code> if the event was successfully
|
|
dispatched. A value of <code>false</code> indicates failure or
|
|
that <code>preventDefault()</code> was called on the event.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="flush" class="tsd-anchor"></a>
|
|
<h3>flush</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">flush<span class="tsd-signature-symbol">(</span>minDiskSpace<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/openfl.net.sharedobjectflushstatus.html" class="tsd-signature-type">SharedObjectFlushStatus</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L272">lib/openfl/net/SharedObject.d.ts:272</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Immediately writes a locally persistent shared object to a local file. If
|
|
you don't use this method, Flash Player writes the shared object to a file
|
|
when the shared object session ends - that is, when the SWF file is
|
|
closed, when the shared object is garbage-collected because it no longer
|
|
has any references to it, or when you call
|
|
<code>SharedObject.clear()</code> or <code>SharedObject.close()</code>.</p>
|
|
</div>
|
|
<p>If this method returns <code>SharedObjectFlushStatus.PENDING</code>,
|
|
Flash Player displays a dialog box asking the user to increase the amount
|
|
of disk space available to objects from this domain. To allow space for
|
|
the shared object to grow when it is saved in the future, which avoids
|
|
return values of <code>PENDING</code>, pass a value for
|
|
<code>minDiskSpace</code>. When Flash Player tries to write the file, it
|
|
looks for the number of bytes passed to <code>minDiskSpace</code>, instead
|
|
of looking for enough space to save the shared object at its current size.</p>
|
|
<p>For example, if you expect a shared object to grow to a maximum size of
|
|
500 bytes, even though it might start out much smaller, pass 500 for
|
|
<code>minDiskSpace</code>. If Flash asks the user to allot disk space for
|
|
the shared object, it asks for 500 bytes. After the user allots the
|
|
requested amount of space, Flash won't have to ask for more space on
|
|
future attempts to flush the object(as long as its size doesn't exceed
|
|
500 bytes).</p>
|
|
<p>After the user responds to the dialog box, this method is called again.
|
|
A <code>netStatus</code> event is dispatched with a <code>code</code>
|
|
property of <code>SharedObject.Flush.Success</code> or
|
|
<code>SharedObject.Flush.Failed</code>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>Error Flash Player cannot write the shared object to disk. This
|
|
error might occur if the user has permanently disallowed
|
|
local information storage for objects from this domain.</p>
|
|
<pre><code> **Note:** Local content can always write shared
|
|
objects <span class="hljs-keyword">from</span> third-party domains(domains other than the
|
|
domain <span class="hljs-keyword">in</span> the current browser<span class="hljs-built_in"> address </span>bar) <span class="hljs-keyword">to</span> disk, even <span class="hljs-keyword">if</span>
|
|
writing of third-party shared objects <span class="hljs-keyword">to</span> disk is
|
|
disallowed.
|
|
</code></pre></dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> minDiskSpace: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The minimum disk space, in bytes, that must be
|
|
allotted for this object.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../enums/openfl.net.sharedobjectflushstatus.html" class="tsd-signature-type">SharedObjectFlushStatus</a></h4>
|
|
<p>Either of the following values:</p>
|
|
<pre><code> * `SharedObjectFlushStatus.PENDING`: The<span class="hljs-built_in"> user </span>has
|
|
permitted local information storage <span class="hljs-keyword">for</span> objects <span class="hljs-keyword">from</span> this domain,
|
|
but the amount of space allotted is <span class="hljs-keyword">not</span> sufficient <span class="hljs-keyword">to</span> store the
|
|
object. Flash Player prompts the<span class="hljs-built_in"> user </span><span class="hljs-keyword">to</span> allow more space. <span class="hljs-keyword">To</span>
|
|
allow space <span class="hljs-keyword">for</span> the shared object <span class="hljs-keyword">to</span> grow when it is saved, thus
|
|
avoiding a `SharedObjectFlushStatus.PENDING` return
|
|
value, pass a value <span class="hljs-keyword">for</span> `minDiskSpace`.
|
|
* `SharedObjectFlushStatus.FLUSHED`: The shared
|
|
object has been successfully written <span class="hljs-keyword">to</span> a file on the local
|
|
disk.
|
|
</code></pre>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="haseventlistener" class="tsd-anchor"></a>
|
|
<h3>has<wbr>Event<wbr>Listener</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">has<wbr>Event<wbr>Listener<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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 <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#haseventlistener">hasEventListener</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L209">lib/openfl/events/EventDispatcher.d.ts:209</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Checks whether the EventDispatcher object has any listeners registered for
|
|
a specific type of event. This allows you to determine where an
|
|
EventDispatcher object has altered handling of an event type in the event
|
|
flow hierarchy. To determine whether a specific event type actually
|
|
triggers an event listener, use <code>willTrigger()</code>.</p>
|
|
</div>
|
|
<p>The difference between <code>hasEventListener()</code> and
|
|
<code>willTrigger()</code> is that <code>hasEventListener()</code>
|
|
examines only the object to which it belongs, whereas
|
|
<code>willTrigger()</code> examines the entire event flow for the event
|
|
specified by the <code>type</code> parameter.</p>
|
|
<p>When <code>hasEventListener()</code> is called from a LoaderInfo
|
|
object, only the listeners that the caller can access are considered.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The type of event.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>A value of <code>true</code> if a listener of the specified type
|
|
is registered; <code>false</code> otherwise.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="removeeventlistener" class="tsd-anchor"></a>
|
|
<h3>remove<wbr>Event<wbr>Listener</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">remove<wbr>Event<wbr>Listener<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, useCapture<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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 <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#removeeventlistener">removeEventListener</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L227">lib/openfl/events/EventDispatcher.d.ts:227</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Removes a listener from the EventDispatcher object. If there is no
|
|
matching listener registered with the EventDispatcher object, a call to
|
|
this method has no effect.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The type of event.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>listener: <span class="tsd-signature-type">function</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-siganture">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>event: <span class="tsd-signature-type">object</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> useCapture: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Specifies whether the listener was registered for the
|
|
capture phase or the target and bubbling phases. If the
|
|
listener was registered for both the capture phase and
|
|
the target and bubbling phases, two calls to
|
|
<code>removeEventListener()</code> are required to
|
|
remove both, one call with <code>useCapture()</code> set
|
|
to <code>true</code>, and another call with
|
|
<code>useCapture()</code> set to <code>false</code>.</p>
|
|
</div>
|
|
</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-external">
|
|
<a name="send" class="tsd-anchor"></a>
|
|
<h3>send</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>arguments<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><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-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L431">lib/openfl/net/SharedObject.d.ts:431</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>arguments: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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-external">
|
|
<a name="setdirty" class="tsd-anchor"></a>
|
|
<h3>set<wbr>Dirty</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Dirty<span class="tsd-signature-symbol">(</span>propertyName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L434">lib/openfl/net/SharedObject.d.ts:434</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>propertyName: <span class="tsd-signature-type">string</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-external">
|
|
<a name="setproperty" class="tsd-anchor"></a>
|
|
<h3>set<wbr>Property</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Property<span class="tsd-signature-symbol">(</span>propertyName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<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">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L437">lib/openfl/net/SharedObject.d.ts:437</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>propertyName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> value: <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 tsd-is-external">
|
|
<a name="tostring" class="tsd-anchor"></a>
|
|
<h3>to<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#tostring">toString</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L230">lib/openfl/events/EventDispatcher.d.ts:230</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="willtrigger" class="tsd-anchor"></a>
|
|
<h3>will<wbr>Trigger</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">will<wbr>Trigger<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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 <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#willtrigger">willTrigger</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L253">lib/openfl/events/EventDispatcher.d.ts:253</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Checks whether an event listener is registered with this EventDispatcher
|
|
object or any of its ancestors for the specified event type. This method
|
|
returns <code>true</code> if an event listener is triggered during any
|
|
phase of the event flow when an event of the specified type is dispatched
|
|
to this EventDispatcher object or any of its descendants.</p>
|
|
</div>
|
|
<p>The difference between the <code>hasEventListener()</code> and the
|
|
<code>willTrigger()</code> methods is that <code>hasEventListener()</code>
|
|
examines only the object to which it belongs, whereas the
|
|
<code>willTrigger()</code> method examines the entire event flow for the
|
|
event specified by the <code>type</code> parameter.</p>
|
|
<p>When <code>willTrigger()</code> is called from a LoaderInfo object,
|
|
only the listeners that the caller can access are considered.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The type of event.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>A value of <code>true</code> if a listener of the specified type
|
|
will be triggered; <code>false</code> otherwise.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="getlocal" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Local</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Local<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, localPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, secure<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.net.sharedobject.html" class="tsd-signature-type">SharedObject</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L425">lib/openfl/net/SharedObject.d.ts:425</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Returns a reference to a locally persistent shared object that is only
|
|
available to the current client. If the shared object does not already
|
|
exist, this method creates one. If any values passed to
|
|
<code>getLocal()</code> are invalid or if the call fails, Flash Player
|
|
throws an exception.</p>
|
|
</div>
|
|
<p>The following code shows how you assign the returned shared object
|
|
reference to a variable:</p>
|
|
<p><code>so:SharedObject =
|
|
SharedObject.getLocal("savedData");</code></p>
|
|
<p><strong>Note:</strong> If the user has chosen to never allow local storage for
|
|
this domain, the object is not saved locally, even if a value for
|
|
<code>localPath</code> is specified. The exception to this rule is local
|
|
content. Local content can always write shared objects from third-party
|
|
domains(domains other than the domain in the current browser address bar)
|
|
to disk, even if writing of third-party shared objects to disk is
|
|
disallowed.</p>
|
|
<p>To avoid name conflicts, Flash looks at the location of the SWF file
|
|
creating the shared object. For example, if a SWF file at
|
|
www.myCompany.com/apps/stockwatcher.swf creates a shared object named
|
|
<code>portfolio</code>, that shared object does not conflict with another
|
|
object named <code>portfolio</code> that was created by a SWF file at
|
|
www.yourCompany.com/photoshoot.swf because the SWF files originate from
|
|
different directories.</p>
|
|
<p>Although the <code>localPath</code> parameter is optional, you should
|
|
give some thought to its use, especially if other SWF files need to access
|
|
the shared object. If the data in the shared object is specific to one SWF
|
|
file that will not be moved to another location, then use of the default
|
|
value makes sense. If other SWF files need access to the shared object, or
|
|
if the SWF file that creates the shared object will later be moved, then
|
|
the value of this parameter affects how accessible the shared object will
|
|
be. For example, if you create a shared object with <code>localPath</code>
|
|
set to the default value of the full path to the SWF file, no other SWF
|
|
file can access that shared object. If you later move the original SWF
|
|
file to another location, not even that SWF file can access the data
|
|
already stored in the shared object.</p>
|
|
<p>To avoid inadvertently restricting access to a shared object, use the
|
|
<code>localpath</code> parameter. The most permissive approach is to set
|
|
<code>localPath</code> to <code>/</code>(slash), which makes the shared
|
|
object available to all SWF files in the domain, but increases the
|
|
likelihood of name conflicts with other shared objects in the domain. A
|
|
more restrictive approach is to append <code>localPath</code> with folder
|
|
names that are in the full path to the SWF file. For example, for a
|
|
<code>portfolio</code> shared object created by the SWF file at
|
|
www.myCompany.com/apps/stockwatcher.swf, you could set the
|
|
<code>localPath</code> parameter to <code>/</code>, <code>/apps</code>, or
|
|
<code>/apps/stockwatcher.swf</code>. You must determine which approach
|
|
provides optimal flexibility for your application.</p>
|
|
<p>When using this method, consider the following security model:</p>
|
|
<ul>
|
|
<li>You cannot access shared objects across sandbox boundaries.</li>
|
|
<li>Users can restrict shared object access by using the Flash Player
|
|
Settings dialog box or the Settings Manager. By default, an application
|
|
can create shared objects of up 100 KB of data per domain. Administrators
|
|
and users can also place restrictions on the ability to write to the file
|
|
system.</li>
|
|
</ul>
|
|
<p>Suppose you publish SWF file content to be played back as local files
|
|
(either locally installed SWF files or EXE files), and you need to access
|
|
a specific shared object from more than one local SWF file. In this
|
|
situation, be aware that for local files, two different locations might be
|
|
used to store shared objects. The domain that is used depends on the
|
|
security permissions granted to the local file that created the shared
|
|
object. Local files can have three different levels of permissions:</p>
|
|
<ol>
|
|
<li>Access to the local filesystem only.</li>
|
|
<li>Access to the network only.</li>
|
|
<li>Access to both the network and the local filesystem.</li>
|
|
</ol>
|
|
<p>Local files with access to the local filesystem(level 1 or 3) store
|
|
their shared objects in one location. Local files without access to the
|
|
local filesystem(level 2) store their shared objects in another
|
|
location.</p>
|
|
<p>You can prevent a SWF file from using this method by setting the
|
|
<code>allowNetworking</code> parameter of the the <code>object</code> and
|
|
<code>embed</code> tags in the HTML page that contains the SWF
|
|
content.</p>
|
|
<p>For more information, see the Flash Player Developer Center Topic:
|
|
<a href="http://www.adobe.com/go/devnet_security_en">Security</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>Error Flash Player cannot create the shared object for whatever
|
|
reason. This error might occur is if persistent shared
|
|
object creation and storage by third-party Flash content is
|
|
prohibited(does not apply to local content). Users can
|
|
prohibit third-party persistent shared objects on the Global
|
|
Storage Settings panel of the Settings Manager, located at
|
|
<a href="http://www.adobe.com/support/documentation/en/flashplayer/help/settings_manager03.html">http://www.adobe.com/support/documentation/en/flashplayer/help/settings_manager03.html</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The name of the object. The name can include forward
|
|
slashes(<code>/</code>); for example,
|
|
<code>work/addresses</code> is a legal name. Spaces are
|
|
not allowed in a shared object name, nor are the
|
|
following characters: <code>~ % & \
|
|
; : " ' , < > ? #</code></p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> localPath: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The full or partial path to the SWF file that created the
|
|
shared object, and that determines where the shared
|
|
object will be stored locally. If you do not specify this
|
|
parameter, the full path is used.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> secure: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Determines whether access to this shared object is
|
|
restricted to SWF files that are delivered over an HTTPS
|
|
connection. If your SWF file is delivered over HTTPS,
|
|
this parameter's value has the following effects:</p>
|
|
<pre><code> * If this parameter is <span class="hljs-built_in">set</span> <span class="hljs-built_in">to</span> `<span class="hljs-literal">true</span>`,
|
|
Flash Player creates <span class="hljs-keyword">a</span> <span class="hljs-built_in">new</span> secure shared object <span class="hljs-keyword">or</span> gets <span class="hljs-keyword">a</span>
|
|
reference <span class="hljs-built_in">to</span> <span class="hljs-keyword">an</span> existing secure shared object. This
|
|
secure shared object can be <span class="hljs-built_in">read</span> <span class="hljs-built_in">from</span> <span class="hljs-keyword">or</span> written <span class="hljs-built_in">to</span> only
|
|
<span class="hljs-keyword">by</span> SWF <span class="hljs-built_in">files</span> delivered over HTTPS that call
|
|
`SharedObject.getLocal()` <span class="hljs-keyword">with</span> <span class="hljs-keyword">the</span>
|
|
`secure` parameter <span class="hljs-built_in">set</span> <span class="hljs-built_in">to</span>
|
|
`<span class="hljs-literal">true</span>`.
|
|
* If this parameter is <span class="hljs-built_in">set</span> <span class="hljs-built_in">to</span> `<span class="hljs-literal">false</span>`,
|
|
Flash Player creates <span class="hljs-keyword">a</span> <span class="hljs-built_in">new</span> shared object <span class="hljs-keyword">or</span> gets <span class="hljs-keyword">a</span>
|
|
reference <span class="hljs-built_in">to</span> <span class="hljs-keyword">an</span> existing shared object that can be <span class="hljs-built_in">read</span>
|
|
<span class="hljs-built_in">from</span> <span class="hljs-keyword">or</span> written <span class="hljs-built_in">to</span> <span class="hljs-keyword">by</span> SWF <span class="hljs-built_in">files</span> delivered over non-HTTPS
|
|
connections.
|
|
|
|
|
|
If your SWF <span class="hljs-built_in">file</span> is delivered over <span class="hljs-keyword">a</span> non-HTTPS
|
|
connection <span class="hljs-keyword">and</span> you <span class="hljs-keyword">try</span> <span class="hljs-built_in">to</span> <span class="hljs-built_in">set</span> this parameter <span class="hljs-built_in">to</span>
|
|
`<span class="hljs-literal">true</span>`, <span class="hljs-keyword">the</span> creation <span class="hljs-keyword">of</span> <span class="hljs-keyword">a</span> <span class="hljs-built_in">new</span> shared object
|
|
(<span class="hljs-keyword">or</span> <span class="hljs-keyword">the</span> access <span class="hljs-keyword">of</span> <span class="hljs-keyword">a</span> previously created secure shared
|
|
object) fails <span class="hljs-keyword">and</span> `<span class="hljs-literal">null</span>` is returned.
|
|
Regardless <span class="hljs-keyword">of</span> <span class="hljs-keyword">the</span> <span class="hljs-built_in">value</span> <span class="hljs-keyword">of</span> this parameter, <span class="hljs-keyword">the</span> created
|
|
shared objects count toward <span class="hljs-keyword">the</span> total amount <span class="hljs-keyword">of</span> disk
|
|
<span class="hljs-literal">space</span> allowed <span class="hljs-keyword">for</span> <span class="hljs-keyword">a</span> domain.
|
|
|
|
The following diagram shows <span class="hljs-keyword">the</span> use <span class="hljs-keyword">of</span> <span class="hljs-keyword">the</span>
|
|
`secure` parameter:
|
|
</code></pre>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="openfl.net.sharedobject.html" class="tsd-signature-type">SharedObject</a></h4>
|
|
<p>A reference to a shared object that is persistent locally and is
|
|
available only to the current client. If Flash Player can't create
|
|
or find the shared object(for example, if <code>localPath</code>
|
|
was specified but no such directory exists), this method throws an
|
|
exception.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a name="getremote" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Remote</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Remote<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, remotePath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, persistence<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, secure<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.net.sharedobject.html" class="tsd-signature-type">SharedObject</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/net/SharedObject.d.ts#L428">lib/openfl/net/SharedObject.d.ts:428</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> remotePath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> persistence: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> secure: <span class="tsd-signature-type">boolean</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="openfl.net.sharedobject.html" class="tsd-signature-type">SharedObject</a></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="label tsd-is-external">
|
|
<span>Externals</span>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.desktop.html">openfl.desktop</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display.html">openfl.display</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display3d.html">openfl.display3D</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.errors.html">openfl.errors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.events.html">openfl.events</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.external.html">openfl.external</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.filters.html">openfl.filters</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.geom.html">openfl.geom</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.media.html">openfl.media</a>
|
|
</li>
|
|
<li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.net.html">openfl.net</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.profiler.html">openfl.profiler</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.sensors.html">openfl.sensors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.system.html">openfl.system</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.text.html">openfl.text</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.ui.html">openfl.ui</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.utils.html">openfl.utils</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external">
|
|
<a href="../enums/openfl.net.sharedobjectflushstatus.html" class="tsd-kind-icon">Shared<wbr>Object<wbr>Flush<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external">
|
|
<a href="../enums/openfl.net.urlloaderdataformat.html" class="tsd-kind-icon">URLLoader<wbr>Data<wbr>Format</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external">
|
|
<a href="../enums/openfl.net.urlrequestmethod.html" class="tsd-kind-icon">URLRequest<wbr>Method</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.filefilter.html" class="tsd-kind-icon">File<wbr>Filter</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.filereference.html" class="tsd-kind-icon">File<wbr>Reference</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.filereferencelist.html" class="tsd-kind-icon">File<wbr>Reference<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.netconnection.html" class="tsd-kind-icon">Net<wbr>Connection</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.netstream.html" class="tsd-kind-icon">Net<wbr>Stream</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html" class="tsd-kind-icon">Shared<wbr>Object</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#client" class="tsd-kind-icon">client</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#data" class="tsd-kind-icon">data</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#fps" class="tsd-kind-icon">fps</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#objectencoding" class="tsd-kind-icon">object<wbr>Encoding</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#size" class="tsd-kind-icon">size</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#defaultobjectencoding" class="tsd-kind-icon">default<wbr>Object<wbr>Encoding</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#addeventlistener" class="tsd-kind-icon">add<wbr>Event<wbr>Listener</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#clear" class="tsd-kind-icon">clear</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#close" class="tsd-kind-icon">close</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#connect" class="tsd-kind-icon">connect</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#dispatchevent" class="tsd-kind-icon">dispatch<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#flush" class="tsd-kind-icon">flush</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#haseventlistener" class="tsd-kind-icon">has<wbr>Event<wbr>Listener</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#removeeventlistener" class="tsd-kind-icon">remove<wbr>Event<wbr>Listener</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#send" class="tsd-kind-icon">send</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#setdirty" class="tsd-kind-icon">set<wbr>Dirty</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#setproperty" class="tsd-kind-icon">set<wbr>Property</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#willtrigger" class="tsd-kind-icon">will<wbr>Trigger</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#getlocal" class="tsd-kind-icon">get<wbr>Local</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
<a href="openfl.net.sharedobject.html#getremote" class="tsd-kind-icon">get<wbr>Remote</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.socket.html" class="tsd-kind-icon">Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.urlloader.html" class="tsd-kind-icon">URLLoader</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.urlrequest.html" class="tsd-kind-icon">URLRequest</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.urlrequestdefaults.html" class="tsd-kind-icon">URLRequest<wbr>Defaults</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.urlrequestheader.html" class="tsd-kind-icon">URLRequest<wbr>Header</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.urlstream.html" class="tsd-kind-icon">URLStream</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.urlvariables.html" class="tsd-kind-icon">URLVariables</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.net.xmlsocket.html" class="tsd-kind-icon">XMLSocket</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.net.html#navigatetourl" class="tsd-kind-icon">navigate<wbr>ToURL</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.net.html#sendtourl" class="tsd-kind-icon">send<wbr>ToURL</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> |