SharedObject  - AS3

Geeft het object aan waarop callback-methoden worden aangeroepen. Het standaardobject is this. U kunt de eigenschap client instellen op een ander object, waardoor callback-methoden worden aangeroepen met dat andere object.

De verzameling kenmerken die aan de eigenschap data van het object is toegewezen; deze kenmerken kunnen worden gedeeld en opgeslagen. Elk kenmerk kan een object zijn van elk type in ActionScript of JavaScript (Array, Number, Boolean, ByteArray, XML, enzovoort). Met de volgende regels worden bijvoorbeeld waarden aan verschillende aspecten van een gezamenlijk object toegewezen:

     var items_array:Array = new Array(101, 346, 483);
     var currentUserIsAdmin:Boolean = true;
     var currentUserName:String = "Ramona";
     
     var my_so:SharedObject = SharedObject.getLocal("superfoo");
     my_so.data.itemNumbers = items_array;
     my_so.data.adminPrivileges = currentUserIsAdmin;
     my_so.data.userName = currentUserName;
     
     for (var prop in my_so.data) {
       trace(prop+": "+my_so.data[prop]);
     }
     

Alle kenmerken van de eigenschap data van een gezamenlijk object worden opgeslagen wanneer het object blijvend is. Het gezamenlijke object bevat de volgende informatie:

     userName: Ramona
     adminPrivileges: true
     itemNumbers: 101,346,483
     

Opmerking: wijs waarden niet direct toe aan de eigenschap data van een gezamenlijk object, zoals in so.data = someValue. Deze toewijzingen worden genegeerd in Flash.

Gebruik code als delete so.data.attributeName om kenmerken te verwijderen van lokale, gezamenlijke objecten. Wanneer u een kenmerk voor een lokaal, gezamenlijk object instelt op null of undefined, wordt het kenmerk niet verwijderd.

Wanneer u waarden van het type private voor een gezamenlijk object wilt maken (waarden die alleen beschikbaar zijn voor de clientinstantie terwijl het object in gebruik is en die niet worden opgeslagen met het object wanneer deze wordt afgesloten), moet u eigenschappen maken die niet de opslagnaam data hebben, zoals wordt getoond in het volgende voorbeeld:

     var my_so:SharedObject = SharedObject.getLocal("superfoo");
     my_so.favoriteColor = "blue";
     my_so.favoriteNightClub = "The Bluenote Tavern";
     my_so.favoriteSong = "My World is Blue";
     
     for (var prop in my_so) {
       trace(prop+": "+my_so[prop]);
     }
     

Het gezamenlijke object bevat de volgende gegevens:

     favoriteSong: My World is Blue
     favoriteNightClub: The Bluenote Tavern
     favoriteColor: blue
     data: [object Object]
     

Voor externe, gezamenlijke objecten die met een server worden gebruikt, zijn alle kenmerken van de eigenschap data beschikbaar voor alle clients die met het gezamenlijke object zijn verbonden en alle kenmerken worden opgeslagen wanneer het object blijvend is. Wanneer een client de waarde van een kenmerk wijzigt, zien alle clients de nieuwe waarde.

Verwante API-elementen

De standaardobjectcodering (AMF-versie) voor alle lokale, gezamenlijke objecten die in het SWF-bestand zijn gemaakt. Wanneer lokale, gezamenlijke objecten naar schijf worden geschreven, geeft de eigenschap SharedObject.defaultObjectEncoding aan welke versie van Action Message Format moet worden gebruikt: de indeling van ActionScript 3.0 (AMF3) of de indeling van ActionScript 1.0 of 2.0 (AMF0).

Zie de beschrijving van de eigenschap objectEncoding voor meer informatie over objectcodering, waaronder het verschil tussen codering in lokale en externe gezamenlijke objecten.

De standaardwaarde van SharedObject.defaultObjectEncoding is ingesteld op het gebruik van de indeling van ActionScript 3.0, AMF3. Wanneer u lokale, gezamenlijk objecten moet schrijven die leesbaar zijn voor SWF-bestanden waarin ActionScript 1.0 of 2.0 wordt gebruikt, stelt u SharedObject.defaultObjectEncoding in op het gebruik van de indeling van ActionScript 1.0 of ActionScript 2.0, flash.net.ObjectEncoding.AMF0. U doet dit aan het begin van het script, voordat u lokale, gezamenlijk objecten maakt. Alle lokale, gezamenlijke objecten die hierna worden gemaakt, gebruiken AMF0-codering en kunnen communiceren met oudere inhoud. U kunt de waarde objectEncoding van bestaande lokale, gezamenlijke objecten niet wijzigen door SharedObject.defaultObjectEncoding in te stellen nadat de lokale, gezamenlijke objecten zijn gemaakt.

Wanneer u de objectcodering voor elk object afzonderlijk wilt instellen, en niet voor alle gezamenlijke objecten die zijn gemaakt door het SWF-bestand, stelt u de eigenschap objectEncoding van het lokale, gezamenlijke object in.

Verwante API-elementen

Geeft het aantal keren per seconde aan dat clientwijzigingen van een gezamenlijk object naar de server worden verzonden.

Gebruik deze methode wanneer u de hoeveelheid verkeer tussen de client en de server wilt beheren. Wanneer bijvoorbeeld de verbinding tussen de client en server relatief langzaam is, wilt u fps mogelijk instellen op een relatief lage waarde. Wanneer de client is verbonden met een toepassing met meerdere gebruikers waarbij timing zeer belangrijk is, wilt u fps mogelijk juist instellen op een relatief hoge waarde.

Wanneer fps wordt ingesteld, wordt een gebeurtenis sync geactiveerd en worden alle wijzigingen in de server bijgewerkt. Wanneer u de server alleen handmatig wilt bijwerken, stelt u fps in op 0.

Wijzigingen worden pas naar de server verzonden wanneer de gebeurtenis sync wordt verzonden. Wanneer de reactietijd van de server lang is, kunnen updates mogelijk minder vaak naar de server worden verzonden dan de waarde die is opgegeven in deze eigenschap.

De objectcodering (AMF-versie) voor dit gezamenlijke object. Wanneer een lokaal, gezamenlijk object naar schijf wordt geschreven, geeft de eigenschap objectEncoding aan welke versie van Action Message Format moet worden gebruikt: de indeling van ActionScript 3.0 (AMF3) of de indeling van ActionScript 1.0 of 2.0 (AMF0).

Objectcodering wordt verschillend verwerkt, afhankelijk van het feit of het gezamenlijk object lokaal of extern is.

• Lokale, gezamenlijke objecten. U de waarde van de eigenschap objectEncoding ophalen of instellen voor lokale, gezamenlijke objecten. De waarde van objectEncoding heeft invloed op de indeling die wordt gebruikt om dit lokale, gezamenlijke object te schrijven. Wanneer dit lokale, gezamenlijke object leesbaar moet zijn voor SWF-bestanden waarin ActionScript 1.0 of 2.0 wordt gebruikt, stelt u objectEncoding in op ObjectEncoding.AMF0. Zelfs wanneer de objectcodering wordt ingesteld om AMF3 te schrijven, kan Flash Player nog steeds lokale, gezamenlijke objecten in AMF0-indeling lezen. Wanneer u de standaardwaarde van deze eigenschap, ObjectEncoding.AMF3, gebruikt, kan uw SWF-bestand dus nog steeds gezamenlijke objecten lezen die zijn gemaakt door SWF-bestanden waarin ActionScript 1.0 of 2.0 wordt gebruikt.
• Externe, gezamenlijke objecten. Wanneer een extern, gezamenlijk object is verbonden met de server, overerft dit object de instelling objectEncoding van de gekoppelde instantie NetConnection (de instantie die wordt gebruikt om het externe, gezamenlijke object te verbinden). Wanneer een extern, gezamenlijk object niet is verbonden met de server, overerft dit object de instelling defaultObjectEncoding van de gekoppelde instantie NetConnection. Aangezien de waarde van de eigenschap objectEncoding van een extern, gezamenlijk object wordt bepaald door de instantie NetConnection, is deze eigenschap alleen-lezen voor externe, gezamenlijke objecten.

Verwante API-elementen

Geeft aan of al dan niet een back-up wordt gemaakt van lokaal gedeelde objecten op de back-upservice van de iOS-cloud.

Geef true of false op:

• true - Voorkomt dat een back-up wordt gemaakt van lokaal gedeelde objecten op de back-upservice van de iOS-cloud.
• false (standaardinstelling) - Er wordt een back-up gemaakt van lokaal gedeelde objecten op de back-upservice van de iOS-cloud.

Deze eigenschap is alleen van toepassing op lokaal gedeelde objecten en is alleen voor iOS.

De huidige grootte van het gezamenlijke object, in bytes.

Flash berekent de grootte van een gezamenlijk object door alle gegevenseigenschappen ervan te doorlopen. Hoe meer gegevenseigenschappen het object heeft, hoe langer het bepalen van de grootte duurt. Het bepalen van de objectgrootte kan een aanzienlijke hoeveelheid verwerkingstijd in beslag nemen. Mogelijk wilt u deze methode vermijden tenzij u deze expliciet moet gebruiken.

import flash.net.SharedObject;

// if these get copied or not
var mySo:SharedObject = SharedObject.getLocal("thehobbit");
mySo.data.username = "bilbobaggins";
trace(mySo.size); // 55

Schoont alle gegevens van lokale, gezamenlijke objecten op en verwijdert het gezamenlijke object van de schijf. De verwijzing naar het gezamenlijke object is nog steeds actief, maar de eigenschappen data ervan zijn verwijderd.

Voor externe, gezamenlijke objecten die met Flash Media Server worden gebruikt, verbreekt clear() de verbinding met het object en schoont alle gegevens op. Wanneer het gezamenlijke object lokaal blijvend is, verwijdert deze methode bovendien het gezamenlijke object van de schijf. De verwijzing naar het gezamenlijke object is nog steeds actief, maar de eigenschappen data ervan zijn verwijderd.

package {
    import flash.net.SharedObject;

    public class SharedObject_clear {
        private var hostName:String = "yourDomain";
        private var username:String = "yourUsername";

        public function SharedObject_clear() {
            var mySo:SharedObject = SharedObject.getLocal(hostName);
            if(mySo.data.username == null) {
                mySo.data.username = username;
                trace("set: " + mySo.data.username); // yourUsername
            }
            else {
                mySo.clear();
                trace("cleared: " + mySo.data.username); // undefined
            }
        }
    }
}

Sluit de verbinding tussen een extern, gezamenlijk object en de server. Wanneer een extern, gezamenlijk object lokaal blijvend is, kan de gebruiker wijzigingen aanbrengen in de lokale kopie van het object nadat deze methode is aangeroepen. De volgende keer dat de gebruiker verbinding maakt met het externe, gezamenlijke object, worden wijzigingen in het lokale object verstuurd naar de server.

Maakt met een extern, gezamenlijk object op een server verbinding via een opgegeven object NetConnection. Gebruik deze methode na het aanroepen van getRemote(). Wanneer de verbinding is gelukt, wordt de gebeurtenis sync verzonden.

Voordat u met een extern, gezamenlijk object gaat werken, moet u eerst op fouten controleren met een instructie try..catch..finally. Luister vervolgens naar de gebeurtenis sync en handel deze af voordat u het gezamenlijke object wijzigt. Wijzigingen die lokaal worden doorgevoerd, voordat de gebeurtenis sync wordt verzonden, kunnen verloren gaan.

Roep de methode connect() aan om verbinding te maken met een extern, gezamenlijk object, bijvoorbeeld:

     var myRemoteSO:SharedObject = SharedObject.getRemote("mo", myNC.uri, false);
     myRemoteSO.connect(myNC);
     

Parameters

Verwante API-elementen

Schrijft een lokaal blijvend gezamenlijk object direct naar een lokaal bestand. Wanneer u deze methode niet gebruikt, schrijft Flash Player het gezamenlijke object naar een bestand wanneer de sessie van het gezamenlijke object wordt beëindigd. Dit gebeurt wanneer het SWF-bestand wordt gesloten, wanneer het gezamenlijke object wordt opgeschoond omdat er geen verwijzingen meer naar bestaan of wanneer uSharedObject.clear() of SharedObject.close() aanroept.

Wanneer deze methode SharedObjectFlushStatus.PENDING retourneert, wordt in Flash Player een dialoogvenster weergegeven waarin de gebruiker wordt gevraagd de hoeveelheid beschikbare schijfruimte voor objecten van dit domein te verhogen. Wanneer u de ruimte voor het gezamenlijke object wilt uitbreiden wanneer het in de toekomst wordt opgeslagen (dit voorkomt geretourneerde waarden PENDING), kunt u een waarde voor minDiskSpace doorgeven. Wanneer Flash Player het bestand probeert te schrijven, wordt gezocht naar het aantal bytes dat aan minDiskSpace is doorgegeven in plaats van te zoeken naar voldoende ruimte om het gezamenlijke object met de huidige grootte op te slaan.

Wanneer u bijvoorbeeld verwacht dat een gezamenlijk object maximaal 500 bytes groot wordt, geeft u 500 door voor minDiskSpace, ook wanneer het object in het begin veel kleiner is. Wanneer Flash de gebruiker vraagt om schijfruimte toe te wijzen voor het gezamenlijke object, wordt er om 500 bytes gevraagd. Wanneer de gebruiker deze hoeveelheid heeft toegewezen, hoeft in Flash niet meer om meer ruimte te worden gevraagd voor toekomstige pogingen om het object leeg te maken (zolang het object niet groter is dan 500 bytes).

Nadat de gebruiker op het dialoogvenster reageert, wordt deze methode weer aangeroepen. Er wordt een gebeurtenis netStatus verzonden met een code-eigenschap SharedObject.Flush.Success of SharedObject.Flush.Failed.

Parameters

Verwante API-elementen

package {
    import flash.net.SharedObject;

    public class SharedObject_flush {
        private var hostName:String = "yourDomain";
        private var username:String = "yourUsername";

        public function SharedObject_flush() {
            var mySo:SharedObject = SharedObject.getLocal(hostName);
            mySo.data.username = username;
            var flushResult:Object = mySo.flush();
            trace("flushResult: " + flushResult);
            trace(mySo.data.username); // yourUsername
        }
    }
}

Retourneert een verwijzing naar een lokaal blijvend gezamenlijk object dat alleen voor de huidige client beschikbaar is. Wanneer het gezamenlijke object nog niet bestaat, wordt dit gemaakt met deze methode. Wanneer een waarde die wordt doorgegeven aan getLocal() ongeldig is, of wanneer de aanroep mislukt, genereert Flash Player een uitzondering.

De volgende code toont hoe u de geretourneerde verwijzing naar een gezamenlijk object toewijst aan een variabele:

var so:SharedObject = SharedObject.getLocal("savedData");

Opmerking: wanneer de gebruiker heeft opgegeven dat lokale opslag voor dit domein nooit is toegestaan, wordt het object niet lokaal opgeslagen, ook niet wanneer een waarde wordt opgegeven voor localPath. De uitzondering op deze regel is lokale inhoud. Lokale inhoud kan altijd gezamenlijke objecten van domeinen van derden (andere domeinen dan het domein in de huidige adresbalk van de browser) naar schijf schrijven, zelfs wanneer het schrijven van gezamenlijke objecten van derden naar schijf niet is toegestaan.

Flash controleert de locatie van het SWF-bestand waarmee het gezamenlijke object is gemaakt om naamconflicten te vermijden. Wanneer een bestand op www.myCompany.com/apps/stockwatcher.swf het gezamenlijke object portfolio maakt, bestaat er bijvoorbeeld geen conflict met een object met de naam portfolio dat is gemaakt door een SWF-bestand op www.yourCompany.com/photoshoot.swf omdat de SWF-bestanden afkomstig zijn uit verschillende mappen.

Hoewel de parameter localPath optioneel is, kan deze in bepaalde gevallen zeer nuttig zijn, vooral wanneer andere SWF-bestanden toegang moeten hebben tot het gezamenlijke object. Wanneer de gegevens in het gezamenlijke object specifiek bij één SWF-bestand horen dat niet naar een andere locatie wordt verplaatst, is het nuttig om de standaardwaarde te gebruiken. Wanneer andere SWF-bestanden toegang tot het gezamenlijke object moeten hebben, of wanneer het SWF-bestand waarmee het gezamenlijke object wordt gemaakt later wordt verplaatst, bepaalt de waarde van deze parameter de toegankelijkheid van het gezamenlijke object. Wanneer u bijvoorbeeld een gezamenlijk object maakt waarvoor localPath is ingesteld op de standaardwaarde van het volledige pad naar het SWF-bestand, heeft geen ander SWF-bestand toegang tot dat gezamenlijke object. Wanneer u het oorspronkelijke SWF-bestand later naar een andere locatie verplaatst, heeft zelfs dat SWF-bestand geen toegang meer tot de gegevens die al zijn opgeslagen in het gezamenlijke object.

Wanneer u wilt voorkomen dat toegang tot een gezamenlijk object per ongeluk wordt beperkt, gebruikt u de parameter localpath. De meest tolerante benadering is om de parameter localPath in te stellen op / (slash). Daarmee is het gezamenlijke object beschikbaar voor alle SWF-bestanden in het domein, maar is de kans op naamconflicten met andere gezamenlijke objecten in het domein groter. Een meer beperkende benadering is om mapnamen uit het volledige pad naar het SWF-bestand toe te voegen aan localPath. Voor een gezamenlijk object portfolio dat is gemaakt door het SWF-bestand op www.myCompany.com/apps/stockwatcher.swf, kunt u de parameter localPath bijvoorbeeld instellen op /, /apps of /apps/stockwatcher.swf. U moet bepalen welke benadering optimale flexibiliteit biedt voor uw toepassing.

Houd rekening met het volgende beveiligingsmodel wanneer u deze methode gebruikt:

• U hebt geen toegang tot gezamenlijke objecten die sandbox-grenzen overschrijden.
• Gebruikers kunnen de toegang tot gezamenlijke objecten beperken via het dialoogvenster Flash Player Settings of via Settings Manager. Een toepassing kan standaard gezamenlijke objecten maken van maximaal 100 kB aan gegevens per domein. Beheerders en gebruikers kunnen ook beperkingen instellen voor het schrijven naar het bestandssysteem.

Stel dat u SWF-bestandsinhoud publiceert om deze af te spelen als lokale bestanden (lokaal geïnstalleerde SWF-bestanden of EXE-bestanden) en u vanuit meerdere lokale SWF-bestanden toegang tot een bepaald gezamenlijk object moet hebben. In dat geval moet u er rekening mee houden dat voor lokale bestanden twee verschillende locaties kunnen worden gebruikt om gezamenlijke objecten op te slaan. Welk domein wordt gebruikt, is afhankelijk van de verleende beveiligingsbevoegdheden aan het lokale bestand waarmee het gezamenlijke object is gemaakt. Voor lokale bestanden kunnen drie verschillende bevoegdheidsniveaus worden ingesteld:

1. Alleen toegang tot het lokale bestandssysteem.
2. Alleen toegang tot het netwerk.
3. Toegang tot zowel het lokale bestandsysteem als het netwerk.

Lokale bestanden met toegang tot het lokale bestandssysteem (niveau 1 of 3) slaan hun gezamenlijke objecten op één locatie op. Lokale bestanden zonder toegang tot het lokale bestandssysteem (niveau 2) slaan hun gezamenlijke objecten op verschillende locaties op.

U kunt voorkomen dat een SWF-bestand deze methode gebruikt door de parameter allowNetworking in te stellen van de tags object en embed op de HTML-pagina die de SWF-inhoud bevat.

Lees voor meer informatie het onderwerp Security in het Flash Player Developer Center.

Parameters

  ~ % & \ ; : " ' , < > ? # 
  

Retourneert een verwijzing naar een gezamenlijk object op Flash Media Server dat door meerdere clients kan worden benaderd. Wanneer het externe, gezamenlijke object nog niet bestaat, wordt dit gemaakt met deze methode.

Als u een extern, gezamenlijk object wilt maken, roept u getRemote() en vervolgens connect() aan om het externe gezamenlijke object te verbinden met de server, zoals hieronder wordt getoond:

     var nc:NetConnection = new NetConnection();
     nc.connect("rtmp://somedomain.com/applicationName");
     var myRemoteSO:SharedObject = SharedObject.getRemote("mo", nc.uri, false);
     myRemoteSO.connect(nc);
     

Luister naar de gebeurtenis sync en handel deze af om te controleren of de lokale en externe kopieën van het gezamenlijke object zijn gesynchroniseerd. Alle clients die dit object willen delen, moeten dezelfde waarden doorgeven voor de parameters name en remotePath.

Wanneer u een gezamenlijk object wilt maken dat alleen beschikbaar is voor de huidige client, gebruikt u SharedObject.getLocal().

Parameters

    ~ % & \ ; :  " ' , > ? ? #

Verwante API-elementen

Verzendt een bericht naar alle clients die met een extern, gezamenlijk object zijn verbonden en naar de client die het bericht heeft verzonden. Wanneer u het bericht wilt verwerken en erop wilt reageren, maakt u een callback-functie die aan het gezamenlijke object is gekoppeld.

Parameters

Geeft aan de server door dat de waarde van een eigenschap in het gezamenlijke object is gewijzigd. Deze methode markeert eigenschappen als dirty, hetgeen gewijzigd betekent.

Roep SharedObject.setProperty() aan om eigenschappen te maken voor een gezamenlijk object.

De methode SharedObject.setProperty() implementeert de methode setDirty(). In de meeste gevallen, bijvoorbeeld wanneer de waarde van een eigenschap een elementair type zoals String of Number is, kunt u setProperty() aanroepen in plaats van setDirty(). Wanneer de waarde van een eigenschap echter een object is dat de eigen eigenschappen bevat, roept u setDirty() aan om aan te geven wanneer een waarde binnen het object is gewijzigd.

Parameters

Verwante API-elementen

Werkt de waarde van een eigenschap in een gezamenlijk object bij en geeft aan de server door dat de waarde van de eigenschap is gewijzigd. De methode setProperty() markeert eigenschappen expliciet als gewijzigd (of 'dirty').

Raadpleeg de documentatie over Flash Media Server voor meer informatie over externe, gezamenlijke objecten.

Opmerking: de methode SharedObject.setProperty() implementeert de methode setDirty(). In de meeste gevallen, bijvoorbeeld wanneer de waarde van een eigenschap een elementair type zoals String of Number is, gebruikt u setProperty() in plaats van setDirty(). Wanneer de waarde van een eigenschap echter een object is dat de eigen eigenschappen bevat, gebruikt u setDirty() om aan te geven wanneer een waarde binnen het object is gewijzigd. Het is over het algemeen raadzaam setProperty() aan te roepen in plaats van setDirty(), omdat setProperty() een eigenschapwaarde alleen bijwerkt wanneer deze waarde is gewijzigd, terwijl setDirty() synchronisatie op alle geabonneerde clients forceert.

Parameters

Verwante API-elementen

Wordt verzonden wanneer een uitzondering asynchroon wordt gegenereerd, dat wil zeggen, vanuit native asynchrone code.

Deze gebeurtenis heeft de volgende eigenschappen:

Wordt verzonden wanneer een instantie SharedObject de status of fout meldt. De gebeurtenis netStatus bevat de eigenschap info. Dit is een informatieobject dat specifieke informatie over de gebeurtenis bevat, zoals of een poging om verbinding te maken is geslaagd en of het gezamenlijke object naar de lokale schijf is geschreven.

Deze gebeurtenis heeft de volgende eigenschappen:

Verwante API-elementen

Wordt verzonden wanneer een extern, gezamenlijk object door de server is bijgewerkt.

Deze gebeurtenis heeft de volgende eigenschappen:

Verwante API-elementen