SharedObject  - AS3

Anger objektet som återkopplingsmetoder anropas i. Standardobjektet är this. Du kan tilldela klientegenskapen till ett annat objekt så kommer återkopplingsmetoder att anropas i det objektet.

Attributen som är tilldelade till egenskapen data för objektet. Dessa attribut kan delas och sparas. Varje attribut kan vara ett objekt av valfri ActionScript- eller JavaScript-typ: Array, Number, Boolean, ByteArray, XML och så vidare. Följande rader tilldelar till exempel värden till olika aspekter av ett delat objekt:

     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]);
     }
     

Alla attribut i egenskapen data i ett delat objekt sparas om objektet är beständigt och innehåller följande information:

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

Obs! Tilldela inte värden direkt till egenskapen data i ett delat objekt (till exempel so.data = someValue). Flash Player ignorerar sådana tilldelningar.

Om du vill ta bort attribut för lokala delade objekt använder du kod som delete so.data.attributeName. Om ett attribut anges som null eller undefined för ett lokalt delat objekt tas attributet inte bort.

Om du vill skapa privata värden för ett delat objekt – det vill säga värden som bara är tillgängliga för den klientinstansen medan objektet används och som inte sparas när den stängs – skapar du egenskaper som inte har namnet data att spara dem i. Se följande exempel:

     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]);
     }
     

Det delade objektet innehåller följande data:

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

För externa delade objekt som används med en server är alla attribut i egenskapen data tillgängliga för alla klienter som är anslutna till det delade objektet och alla attribut sparas om objektet är beständigt. Om en klient ändrar värdet för ett attribut ser alla klienter det nya värdet.

Relaterade API-element

Standardobjektkodningen (AMF-version) för alla lokala delade objekt som skapats i SWF-filen. När lokala delade objekt skrivs till disken anger egenskapen SharedObject.defaultObjectEncoding vilken AMF-version som ska användas: formatet ActionScript 3.0 (AMF3) eller formatet ActionScript 1.0 eller 2.0 (AMF0).

Mer information om objektkodning, inklusive skillnaden mellan kodning i lokala och externa delade objekt, finns i beskrivningen för egenskapen objectEncoding.

Med standardvärdet för SharedObject.defaultObjectEncoding används formatet ActionScript 3.0 (AMF3). Om du behöver skriva lokala delade objekt som kan läsas av SWF-filer i ActionScript 2.0 eller 1.0 anger du att SharedObject.defaultObjectEncoding ska använda motsvarande format flash.net.ObjectEncoding.AMF0 i början av skriptet, innan du skapar några lokala delade objekt. Alla lokala delade objekt som skapas efter detta kommer att använda AMF0-kodning och kan användas med äldre innehåll. När de lokala delade objekten har skapats kan du inte ändra värdet objectEncoding för dessa objekt genom inställning av SharedObject.defaultObjectEncoding.

Om du vill ange objektkodning per objekt, istället för alla delade objekt som skapas av SWF-filen, anger du egenskapen objectEncoding för det lokala delade objektet.

Relaterade API-element

Anger hur många gånger per sekund som en klients ändringar i ett delat objekt skickas till servern.

Använd den här metoden när du vill kontrollera trafiken mellan klienten och servern. Om t.ex. anslutningen mellan klienten och servern är relativt långsam kanske du vill ange fps med ett lågt värde. Och omvänt gäller om klienten är ansluten till ett fleranvändarprogram där timing är viktigt och då kanske du vill ange fps med ett högt värde.

När en inställning av fps görs kommer händelsen sync att triggas och alla ändringar uppdateras på servern. Om du endast vill uppdatera servern manuellt anger du fps med 0.

Ändringar skickas inte till servern förrän händelsen sync har skickats. Detta innebär att om svarstiden från servern är långsam kan uppdateringar inte skickas så ofta som egenskapens värde anger.

Objektkodningen (AMF-version) för det här delade objektet. När ett lokalt delat objekt skrivs till disken anger egenskapen objectEncoding vilken AMF-version som ska användas: formatet ActionScript 3.0 (AMF3) eller formatet ActionScript 1.0 eller 2.0 (AMF0).

Objektkodningen hanteras olika beroende på om det delade objektet är lokalt eller externt.

• Local shared objects. Du kan hämta eller ange värdet för egenskapen objectEncoding för lokala delade objekt. Värdet för objectEncoding påverkar vilken formatering som används vid writing av det lokala delade objektet. Om det lokala delade objektet måste vara läsbart av SWF-filer i ActionScript 2.0 eller 1.0 anger du objectEncoding med ObjectEncoding.AMF0. Även om objektkodningen är inställd att skriva i AMF3-format kan Flash Player läsa lokala delade objekt i AMF0-format. Detta innebär att om du använder standardvärdet för den här egenskapen, ObjectEncoding.AMF3, kan SWF-filen ändå läsa delade objekt som skapats av SWF-filer i ActionScript 2.0 eller 1.0.
• Remote shared objects. Vid anslutning till servern ärver ett externt delat objekt objectEncoding-inställningen från den associerade NetConnection-instansen (den instans som används vid anslutningen till det externa delade objektet). När det inte finns någon anslutning till servern ärver ett externt delat objekt defaultObjectEncoding-inställningen från den associerade NetConnection-instansen. Eftersom värdet för egenskapen objectEncoding i ett externt delat objekt avgörs av NetConnection-instansen är denna egenskap skrivskyddad för externa delade objekt.

Relaterade API-element

Anger huruvida lokala delade objekt ska säkerhetskopieras med säkerhetskopieringstjänsten i iOS-molnet.

Ange true eller false:

• true - Förhindrar att alla lokalt delade objekt säkerhetskopieras med säkerhetskopieringstjänsten i iOS-molnet.
• false (standard) - Lokala delade objekt kommer att säkerhetskopieras med säkerhetskopieringstjänsten i iOS-molnet

Den här egenskapen gäller bara för lokalt delade objekt och gäller endast för iOS.

Det delade objektets aktuella storlek i byte.

Flash beräknar ett delat objekts storlek genom att gå igenom alla dess dataegenskaper. Ju fler dataegenskaper objektet har, desto längre tid tar det att uppskatta storleken. Att uppskatta objektstorlek kan ta lång tid. Undvik därför att använda den här metoden om du inte måste.

import flash.net.SharedObject;

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

Tar bort alla data och det delade objektet från disken för lokala delade objekt. Referensen till det delade objektet är fortfarande aktivt, men alla dataegenskaper tas bort.

För externa delade objekt som används med Flash Media Server kopplar clear() bort objektet och tar bort alla data. Om det delade objektet är lokalt beständigt tar motoden också bort det från disken. Referensen till det delade objektet är fortfarande aktivt, men alla dataegenskaper tas bort.

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
            }
        }
    }
}

Stänger anslutningen mellan ett delat objekt och servern. Om ett externt delat objekt är lokalt beständigt kan användaren göra ändringar i den lokala kopian av objektet efter att den här metoden har anropats. Eventuella ändringar som har gjorts i det lokala objektet skickas till servern nästa gång som användaren ansluter till det externa delade objektet.

Ansluter till ett delat objekt på servern via ett angivet NetConnection-objekt. Använd den här metoden efter att du har anropat getRemote(). När en anslutning har upprättats skickas händelsen sync.

Innan du försöker arbeta med ett externt delat objekt ska du söka efter eventuella fel med en try..catch..finally-sats. Avlyssna och hantera sedan händelsen sync innan du gör ändringar i det delade objektet. Ändringar som görs lokalt – innan händelsen sync skickas – kan försvinna.

Anropa metoden connect() för att ansluta till ett externt delat objekt, till exempel:

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

Parametrar

Relaterade API-element

Skriver omedelbart ett lokalt beständigt delat objekt i en lokal fil. Om du inte använder den här metoden skriver Flash Player det delade objektet på en fil när det delade objektets session tar slut, det vill säga när SWF-filen stängs och det delade objektet skräpsamlas eftersom det inte längre finns några referenser till det, eller när du anropar SharedObject.clear() eller SharedObject.close().

Om metoden returnerar SharedObjectFlushStatus.PENDING visas en dialogruta där användaren uppmanas att öka mängden tillgängligt utrymme för objekt från den här domänen. Om du vill att utrymmet för det delade objektet ska utökas när det sparas igen så att returvärdet PENDING kan undvikas, kan du ange ett värde för minDiskSpace. När Flash Player försöker skriva till filen används det antal byte som angetts för minDiskSpace i stället för att Flash Player söker efter tillräckligt utrymme för att spara det delade objektet med dess nuvarande storlek.

Om du förväntar dig att det delade objektet växer upp till 500 byte trots att det är mycket mindre från början, anger du 500 för minDiskSpace. Om användaren uppmanas att tilldela diskutrymme för det delade objektet efterfrågas 500 byte. När användaren har tilldelat det minnesutrymme som behövs behöver inte Flash efterfråga mer utrymme när objektet sparas igen (förutsatt att storleken inte överskrider 500 byte).

När användaren har svarat i dialogrutan anropas metoden igen. En netStatus-händelse skickas med code-egenskapen SharedObject.Flush.Success eller SharedObject.Flush.Failed.

Parametrar

Relaterade API-element

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
        }
    }
}

Returnerar en referens till ett lokalt beständigt delat objekt som bara är tillgängligt för den nuvarande klienten. Om det delade objektet inte redan finns skapar metoden ett. Om några värden som skickades till getLocal() är ogiltiga eller om anropet misslyckas genereras ett undantag i Flash Player.

I följande kod visas hur du tilldelar returnerat referensvärde för delat objekt till en variabel:

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

Obs! Om användaren har valt att aldrig tillåta lokal lagring för den här domänen sparas inte objektet lokalt, även om ett värde anges för localPath. Undantaget från regeln är lokalt innehåll. Lokalt innehåll kan alltid skriva delade objekt från utomstående domäner (andra domäner än den som är i webbläsarens adressfält), även om delade objekt inte får skrivas på disken av utomstående domäner.

Namnkonflikter undviks genom att Flash undersöker den plats där SWF-filen som skapar det delade objektet finns. Om en SWF-fil på www.myCompany.com/apps/stockwatcher.swf skapar ett delat objekt med namnet portfolio är det delade objektet inte i konflikt med ett annat objekt som heter portfolio som skapats av en SWF-fil på www.yourCompany.com/photoshoot.swf eftersom SWF-filerna kommer från olika kataloger.

Parametern localPath är valfri, men det kan vara bra att använda den, särskilt om andra SWF-filer behöver få tillgång till det delade objektet. Om data i det delade objektet är specifika för en SWF-fil som inte kommer att flyttas till någon annan plats går det bra att använda standardvärdet. Om andra SWF-filer behöver få tillgång till det delade objektet eller om SWF-filen som skapar det delade objektet kommer att flyttas senare, påverkar parameterns värde åtkomsten till det delade objektet. Om du till exempel skapar ett delat objekt där localPath ställts in på standardvärdet, som är den fullständiga sökvägen till SWF-filen, får inga andra SWF-filer tillgång till det delade objektet. Om du senare flyttar den ursprungliga SWF-filen till en annan plats har inte ens den SWF-filen tillgång till data som redan sparats i det delade objektet.

Använd parametern localpath för att undvika begränsa åtkomst till ett delat objekt av misstag. Den friaste inställningen är att ställa in parametern localPath på /. Då är det delade objektet tillgängligt för alla SWF-filer i domänen, men risken för namnkonflikter med andra delade objekt i domänen ökar. En mer begränsad inställning är att lägga till mappnamnen som ingår i hela SWF-filens sökväg i localPath. För till exempel det delade objektet portfolio som skapats av SWF-filen på www.myCompany.com/apps/stockwatcher.swf, kan du ange parametern localPath med /, /apps eller /apps/stockwatcher.swf. Du måste avgöra vilket alternativ som ger bäst flexibilitet för programmet.

Överväg följande säkerhetsmodell när du använder den här metoden:

• Det går inte att använda delade objekt över sandlådegränser.
• Användare kan begränsa åtkomst till delade objekt i dialogrutan Inställningar i Flash Player eller med Inställningshanteraren. Med standardinställningen kan ett program skapa delade objekt på upp till 100 kB per domän. Administratörer och användare kan också ange egna gränser för hur mycket som får skrivas i filsystemet.

Anta att du ska publicera SWF-filinnehåll för lokal uppspelning (antingen lokala SWF-filer eller EXE-filer) och att du behöver åtkomst till ett specifikt delat objekt från mer än en lokal SWF-fil. Då bör du tänka på att med lokala filer kan två olika platser användas vid lagring av delade objekt. Vilken domän som används beror på vilken säkerhetsbehörighet den lokala filen som skapade det delade objektet har. Lokala filer kan ha tre olika behörighetsnivåer:

1. Åtkomst endast till det lokala filsystemet.
2. Åtkomst enbart till nätverket.
3. Åtkomst till både nätverket och det lokala filsystemet.

Lokala filer med åtkomst till det lokala filsystemet (nivå 1 eller 3) sparar sina delade objekt på en plats. Lokala filer utan åtkomst till det lokala filsystemet (nivå 2) sparar sina delade objekt på en annan plats.

Du kan förhindra att metoden används av en SWF-fil genom att ställa in parametern allowNetworking i object- och embed-taggarna på den HTML-sida där SWF-innehållet finns.

Mer information finns i avsnittet Security på Flash Player Developer Center.

Parametrar

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

Returnerar en referens till ett delat objekt på Flash Media Server som flera klienter har åtkomst till. Om det externa delade objektet inte redan finns skapar metoden ett.

Om du vill skapa ett externt delat objekt anropar du getRemote() och sedan connect() för att ansluta det externa delade objektet till servern, liksom i följande:

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

Bekräfta att lokala och externa kopior av det delade objektet är synkroniserade genom att avlyssna och hantera händelsen sync. Alla klienter som vill dela detta objekt måste skicka samma värden för parametrarna name och remotePath.

För att skapa ett delat objekt som är tillgängligt endast för aktuell klient använder du SharedObject.getLocal().

Parametrar

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

Relaterade API-element

Sänder ett meddelande till alla klienter som är anslutna till det delade objektet, inklusive klienten som skickade meddelandet. För att fortsätta och åtgärda meddelandet skapar du en callback-funktion som är kopplad till det delade objektet.

Parametrar

Anger för servern att värdet för en egenskap i det delade objektet har ändrats. Den här metoden markerar egenskaper som dirty, vilket innebär att de har ändrats.

Anropa SharedObject.setProperty() om du vill skapa egenskaper för ett delat objekt.

Metoden SharedObject.setProperty() implementerar setDirty(). I de flesta fall, som exempelvis när värdet för en egenskap är en primitiv typ som String eller Number, kan du anropa setProperty() istället för setDirty(). När värdet för en egenskap är ett objekt som innehåller de egna egenskaperna anropar du däremot setDirty() för att ange att värdet inom objektet har ändrats.

Parametrar

Relaterade API-element

Uppdaterar värdet för en egenskap i ett delat objekt och anger för servern att egenskapens värde har ändrats. Med metoden setProperty() markeras explicit egenskaper som ändrade (dirty).

Mer information om externa delade objekt finns i dokumentationen för Flash Media Server.

Obs! Metoden SharedObject.setProperty() implementerar metoden setDirty(). I de flesta fall, som exempelvis när värdet för en egenskap är en primitiv typ som String eller Number, använder du setProperty() istället för setDirty(). Däremot, när värdet för en egenskap är ett objekt som innehåller de egna egenskaperna, använder du setDirty() för att ange att värdet inom objektet har ändrats. Det är i allmänhet bättre att anropa setProperty() istället för setDirty(), eftersom med setProperty() uppdateras ett egenskapsvärde endast om värdet har ändrats. Med setDirty() genomförs synkronisering på alla mottagande klienter.

Parametrar

Relaterade API-element

Skickas om ett undantag inträffar asynkront, d.v.s. från ursprunglig asynkron kod.

Den här händelsen har följande egenskaper:

Skickas om SharedObject-instansen ger en status- eller felrapport. Händelsen netStatus innehåller egenskapen info, vilket är ett informationsobjekt som innehåller specifik information om händelsen, t.ex. om en anslutning lyckades eller om det delade objektet skrevs till den lokala diskenheten.

Den här händelsen har följande egenskaper:

Relaterade API-element

Skickas när ett externt delat objekt har uppdaterats av servern.

Den här händelsen har följande egenskaper:

Relaterade API-element