SharedObject  - AS3

Indica el objeto en el que se invocan los métodos callback. El objeto predeterminado es this. Se puede establecer la propiedad del cliente en otro objeto y los métodos callback se invocarán en dicho objeto.

Conjunto de atributos asignados a la propiedad data del objeto; estos atributos pueden compartirse y almacenarse. Cada atributo puede ser un objeto de cualquier tipo de ActionScript o JavaScript (Array, Number, Boolean, ByteArray, XML, etc.). Por ejemplo, las siguientes líneas asignan valores a diversos aspectos de un objeto compartido:

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

Todos los atributos de la propiedad data de un objeto compartido se guardan si el objeto es persistente, y el objeto compartido contiene la siguiente información:

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

Nota: no asigne valores directamente a la propiedad data de un objeto compartido, como en so.data = someValue; Flash no tiene en cuenta estas asignaciones.

Para eliminar atributos de objetos locales compartidos, utilice código como, por ejemplo, delete so.data.attributeName; la configuración de un atributo con el valor null o undefined para un objeto local compartido no elimina el atributo en cuestión.

Para crear valores private para un objeto compartido (los valores que sólo están disponibles para la instancia de cliente mientras el objeto se está utilizando no se almacenan con el objeto cuando se cierra), cree propiedades que no sean data con nombre para almacenarlos, como se muestra en el siguiente ejemplo:

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

El objeto compartido contiene los siguientes datos:

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

En los objetos compartidos remotos utilizados con un servidor, todos los atributos de la propiedad data están disponibles para todos los clientes conectados al objeto compartido y, si el objeto es persistente, se guardan todos los atributos. Si un cliente cambia el valor de un atributo, todos los clientes ven ahora el nuevo valor.

Elementos de API relacionados

La codificación predeterminada del objeto (versión de AMF) para todos los objetos compartidos locales creados en el archivo SWF. Cuando se escriben los objetos compartidos locales en el disco, la propiedad SharedObject.defaultObjectEncoding indica qué versión de formato de mensaje de acción se debe utilizar: el formato ActionScript 3.0 (AMF3) o el formato ActionScript 1.0 ó 2.0 (AMF0).

Para más información sobre la codificación de objetos, incluida la diferencia entre la codificación de objetos compartidos locales y remotos, consulte la descripción de la propiedad objectEncoding.

El valor predeterminado de SharedObject.defaultObjectEncoding se establece para utilizar el formato ActionScript 3.0, AMF3. Si necesita escribir objetos compartidos locales legibles para archivos SWF de ActionScript 2.0 ó 1.0, establezca SharedObject.defaultObjectEncoding para que utilice el formato ActionScript 1.0 ó ActionScript 2.0, flash.net.ObjectEncoding.AMF0, al principio del script, antes de crear ningún objeto compartido local. Todos los objetos compartidos locales creados a partir de ese momento utilizarán la codificación AMF0 y podrán interactuar con el contenido más antiguo. No es posible cambiar el valor objectEncoding de los objetos compartidos locales existentes estableciendo SharedObject.defaultObjectEncoding tras crear los objetos compartidos locales.

Para establecer la codificación del objeto de uno en uno, y no para todos los objetos compartidos creados por el archivo SWF, establezca la propiedad objectEncoding del objeto compartido local.

Elementos de API relacionados

Especifica el número de veces por segundo que se envían al servidor los cambios realizados por el cliente en un objeto compartido.

Utilice este método cuando quiera controlar la cantidad de tráfico entre el cliente y el servidor. Por ejemplo, si la conexión entre el cliente y el servidor es relativamente lenta, fps se puede establecer en un valor relativamente bajo. Por el contrario, si el cliente está conectado a una aplicación multiusuario en la que el tiempo juega un papel importante, fps se puede establecer en un valor relativamente alto.

Al definir fps se activa un evento sync y se actualizan todos los cambios en el servidor. Si sólo quiere actualizar el servidor manualmente, defina fps como 0.

Los cambios se envían al servidor sólo cuando se ha distribuido el evento sync. Esto quiere decir que, si el tiempo de respuesta del servidor es lento, las actualizaciones se enviarán al servidor con menor frecuencia que el valor especificado en esta propiedad.

La codificación del objeto (versión del AMF) para este objeto compartido. Cuando se escribe un objetos compartido local en el disco, la propiedad objectEncoding indica qué versión de formato de mensaje de acción se debe utilizar: el formato ActionScript 3.0 (AMF3) o el formato ActionScript 1.0 ó 2.0 (AMF0).

La codificación de objetos no se trata del mismo modo si el objeto compartido es local o remoto.

• Objetos compartidos locales. Se puede obtener o establecer el valor de la propiedad objectEncoding para objetos compartidos locales. El valor de objectEncoding afecta al formato que se utiliza para escribir este archivo compartido local. Si necesita que el objeto compartido local sea legible en archivos SWF de ActionScript 2.0 ó 1.0, defina objectEncoding como ObjectEncoding.AMF0. Aunque la codificación de un objeto se establezca para escribir en AMF3, Flash Player sigue pudiendo leer objetos compartidos locales AMF0. Esto quiere decir que, si utiliza el valor predeterminado de esta propiedad, ObjectEncoding.AMF3, el archivo SWF podrá seguir leyendo objetos compartidos creados por archivos SWF de ActionScript 2.0 ó 1.0.
• Objetos compartidos remotos. Si está conectado al servidor, un objeto compartido remoto hereda los parámetros de objectEncoding de la instancia de NetConnection asociada (la instancia que se utiliza para conectar con el objeto compartido remoto). Si no está conectado al servidor, el objeto compartido remoto hereda los parámetros de defaultObjectEncoding de la instancia de NetConnection asociada. Dado que el valor de la propiedad objectEncoding de un objeto compartido remoto viene determinada por la instancia de NetConnection, esta propiedad es de sólo lectura para los objetos compartidos remotos.

Elementos de API relacionados

Especifica si se deben crear copias de seguridad de objetos compartidos locales en el servicio de copia de seguridad en la nube de iOS.

Especifique true o false:

• true: impide la creación de copias de seguridad de objetos compartidos locales en el servicio de copia de seguridad en la nube de iOS.
• false (valor predeterminado): se crearán copias de seguridad de objetos compartidos locales en el servicio de copia de seguridad en la nube de iOS.

Esta propiedad solo se aplica a objetos compartidos locales y es únicamente para iOS.

El tamaño actual del objeto compartido, expresado en bytes.

Flash calcula el tamaño de un objeto compartido comprobando todas sus propiedades de datos; cuantas más propiedades de datos tenga el objeto, mayor será el tiempo necesario para estimar su tamaño. La estimación del tamaño de un objeto puede consumir bastante tiempo de proceso, por lo que es posible que prefiera evitar este método si no lo necesita por un motivo concreto.

import flash.net.SharedObject;

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

En el caso de objetos compartidos locales, se purgan todos los datos y se elimina el objeto compartido del disco. La referencia al objeto compartido sigue activa, pero las propiedades de sus datos se eliminan.

En el caso de objetos compartidos remotos utilizados con Flash Media Server, clear() desconecta el objeto y purga todos los datos. Si el objeto compartido es persistente localmente, este método también lo elimina del disco. La referencia al objeto compartido sigue activa, pero las propiedades de sus datos se eliminan.

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

Cierra la conexión entre un objeto compartido remoto y el servidor. Si el objeto compartido remoto es persistente de forma local, el usuario puede realizar cambios en la copia local del objeto tras haber llamado a este método. Todos los cambios realizados en el objeto local se enviarán al servidor la próxima vez que el usuario se conecte al objeto compartido remoto.

Conecta a un objeto compartido remoto en un servidor a través de un objeto NetConnection especificado. Utilice este método después de llamar a getRemote(). Si la conexión se realiza con éxito, se distribuye el evento sync.

Antes de intentar trabajar con un objeto compartido remoto, compruebe primero si hay errores utilizando una sentencia try..catch..finally. A continuación, detecte y gestione el evento sync antes de realizar modificaciones en el objeto compartido. Todos los cambios realizados localmente, antes de distribuir el evento sync, podrían perderse.

Llame al método connect() para conectarse a un objeto compartido remoto, por ejemplo:

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

Parámetros

Elementos de API relacionados

Graba inmediatamente un objeto compartido persistente localmente en un archivo local. Si no utiliza este método, Flash Player grabará el objeto compartido en un archivo cuando termine la sesión del objeto; es decir, cuando se cierre el archivo SWF, cuando se eliminen los datos innecesarios del objeto compartido porque ya no tiene ninguna referencia a él o cuando llame a SharedObject.clear() o SharedObject.close().

Si este método devuelve SharedObjectFlushStatus.PENDING, Flash Player mostrará un cuadro de diálogo en el que se pedirá al usuario que aumente el espacio en disco disponible para objetos de este dominio. Para permitir que crezca el espacio asignado al objeto compartido cuando vuelva a guardarse, lo que evita que se devuelva el valor PENDING, pase un valor para minDiskSpace. Cuando Flash Player intenta grabar el archivo, busca el número de bytes pasados a minDiskSpace, en lugar de buscar el espacio suficiente para guardar el objeto compartido con su tamaño actual.

Por ejemplo, si espera que un objeto compartido crezca hasta un tamaño máximo de 500 bytes, aunque es posible que su tamaño inicial sea muy inferior a éste, pase el valor 500 para minDiskSpace. Si Flash pide al usuario que asigne espacio del disco al objeto compartido, pide 500 bytes. Una vez que el usuario asigne la cantidad de espacio solicitada, Flash no tendrá que solicitar más espacio en posteriores intentos de almacenamiento del objeto (siempre y cuando su tamaño no supere 500 bytes).

Una vez que el usuario responde al cuadro de diálogo, se vuelve a llamar a este método. Se distribuye un evento netStatus con una propiedad code de SharedObject.Flush.Success o SharedObject.Flush.Failed.

Parámetros

Elementos de API relacionados

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

Devuelve una referencia a un objeto compartido persistente localmente que sólo está disponible para el cliente actual. Si el objeto compartido no existe ya, este método crea uno. Si alguno de los valores transferidos a getLocal() no son válidos o si la llamada produce un error, Flash Player emitirá una excepción.

El siguiente código muestra cómo asignar la referencia del objeto compartido devuelto a una variable:

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

Nota: si el usuario ha optado por no permitir nunca el almacenamiento local para este dominio, el objeto no se guardará localmente aunque se especifique un valor para localPath. La excepción a esta regla es el contenido local. El contenido local siempre puede escribir en el disco objetos compartidos de dominios de terceros (distintos del que aparece en la barra de direcciones actual del navegador), aunque no esté admitida dicha operación.

Para evitar conflictos de nombres, Flash examina la ubicación del archivo SWF que está creando el objeto compartido. Por ejemplo, si un archivo SWF ubicado en www.myCompany.com/apps/stockwatcher.swf crea un objeto compartido denominado portfolio, el objeto compartido no entra en conflicto con otro objeto portfolio creado por un archivo SWF en www.yourCompany.com/photoshoot.swf porque los archivos SWF se originan en directorios distintos.

Aunque el parámetro localPath es opcional, debe considerar su utilización, particularmente si otros archivos SWF van a necesitar acceder al objeto compartido. Si los datos del objeto compartido son específicos de un archivo SWF que no se trasladará a otra ubicación, lo más recomendable será utilizar el valor predeterminado. Si otros archivos SWF necesitan acceder al objeto compartido o si el archivo SWF que crea el objeto compartido se va a trasladar posteriormente, el valor de este parámetro puede afectar al acceso al objeto compartido. Por ejemplo, si crea un objeto compartido con localPath configurado con el valor predeterminado de ruta completa del archivo SWF, ningún otro archivo SWF podrá acceder a dicho objeto compartido. Si posteriormente traslada el archivo SWF original a otra ubicación, ni tan siquiera dicho archivo SWF podrá acceder a los datos ya almacenados en el objeto compartido.

Para evitar las restricciones involuntarias de acceso al objeto compartido, utilice el parámetro localpath. El enfoque más permisivo consiste en establecer localPath en / (barra), lo que pone el objeto compartido a disposición de todos los archivos SWF del dominio pero aumenta la probabilidad de que se produzcan conflictos de nombres con otros objetos compartidos del dominio. Un enfoque más restrictivo es añadir localPath a los nombres de carpetas que se encuentren en la ruta completa del archivo SWF. Por ejemplo, para un objeto compartido portfolio creado por el archivo SWF en www.myCompany.com/apps/stockwatcher.swf, se establecería el parámetro localPath como /, /apps o /apps/stockwatcher.swf. Deberá determinar qué enfoque ofrece máxima flexibilidad para su aplicación.

Cuando utilice este método, puede ser conveniente usar el modelo de seguridad siguiente:

• No puede acceder a objetos compartidos de otros entornos limitados.
• Los usuarios pueden limitar el acceso a objetos compartidos utilizando el cuadro de diálogo Configuración de Flash Player o el Administrador de configuración. De forma predeterminada, una aplicación puede crear objetos compartidos con un máximo de 100 KB de datos por cada dominio. Los administradores y los usuarios también pueden limitar la capacidad de escribir en el sistema de archivos.

Supongamos que se publica el contenido de un archivo SWF para reproducirlo como archivo local (archivos SWF o EXE instalados localmente) y necesitamos acceder a un objeto compartido concreto desde más de uno de los archivos SWF locales. En esta situación, se debe tener en cuenta que se pueden utilizar dos ubicaciones distintas en los archivos locales para almacenar objetos compartidos. El dominio utilizado depende de los permisos de seguridad concedidos al archivo local que creó el objeto compartido. Los archivos locales pueden tener tres niveles de permisos diferentes:

1. Acceso sólo al sistema de archivos local.
2. Acceso sólo a la red.
3. Acceso a la red y al sistema de archivos local.

Los archivos locales con acceso al sistema de archivos local (nivel 1 ó 3) almacenan sus objetos compartidos en una ubicación. Los archivos locales sin acceso al sistema de archivos local (nivel 2) almacenan sus objetos compartidos en otra ubicación.

Asimismo, se puede impedir que un archivo SWF utilice este método si define el parámetro allowNetworking de las etiquetas object y embed de la página HTML que aloja el contenido SWF.

Para obtener más información, consulte el tema del Centro de desarrollo de Flash Player Seguridad.

Parámetros

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

Devuelve una referencia a un objeto compartido en Flash Media Server al que pueden acceder varios clientes. Si el objeto compartido remoto no existe aún, este método crea uno.

Para crear un objeto compartido remoto, llame a getRemote(), la llamada connect() permite conectar el objeto compartido remoto al servidor, como se muestra a continuación:

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

Para confirmar que las copias local y remota del objeto compartido están sincronizadas, utilice y gestione el evento sync Todos los clientes que quieran compartir este objeto deben transferir los mismos valores para los parámetros name y remotePath.

Para crear un objeto compartido disponible sólo para el cliente actual, utilice SharedObject.getLocal().

Parámetros

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

Elementos de API relacionados

Difunde un mensaje a todos los clientes conectados a un objeto compartido remoto, incluido el cliente que envía el mensaje. Para procesar y responder al mensaje, cree una función callback conectada al objeto compartido.

Parámetros

Indica al servidor que ha cambiado el valor de una propiedad en el objeto compartido. Este método marca las propiedades como dirty, lo que indica que ha cambiado.

Llame a SharedObject.setProperty() para crear propiedades para un objeto compartido.

El método SharedObject.setProperty() implementa setDirty(). En la mayoría de los casos (por ejemplo, cuando el valor de una propiedad es un tipo simple como String o Number), se puede llamar a setProperty() en lugar de setDirty(). Sin embargo, cuando el valor de una propiedad es un objeto que contiene sus propias propiedades, llame a setDirty() para indicar cuándo ha cambiado un valor del objeto.

Parámetros

Elementos de API relacionados

Actualiza el valor de una propiedad de un objeto compartido e indica al servidor que el valor de la propiedad ha cambiado. El método setProperty() marca explícitamente las propiedades como modificadas o no definitivas (dirty).

Para obtener información adicional sobre los objetos compartidos remotos, consulte la documentación de Flash Media Server.

Nota: el método SharedObject.setProperty() implementa el método setDirty(). En la mayoría de los casos (por ejemplo, cuando el valor de una propiedad es un tipo simple como String o Number), se utiliza setProperty() en lugar de setDirty. Sin embargo, cuando el valor de una propiedad es un objeto que contiene sus propias propiedades, se utiliza setDirty() para indicar cuándo ha cambiado el valor del objeto. En general, es aconsejable llamar a setProperty() y no a setDirty(), ya que setProperty() actualiza los valores de la propiedad solamente cuando éstos cambian, mientras que setDirty() obliga a sincronizar en todos los clientes suscritos.

Parámetros

Elementos de API relacionados

Se distribuye cuando se emite una excepción de forma asíncrona, es decir, desde un código asíncrono nativo.

Este evento tiene las propiedades siguientes:

Se distribuye cuando una instancia de SharedObject informa sobre su estado o situación de error. El evento netStatus contiene una propiedad info, que es un objeto de información que contiene información específica sobre el evento, por ejemplo, si el intento de conexión se realizó correctamente o si falló, o si se ha conseguido escribir el objeto compartido en el disco local.

Este evento tiene las propiedades siguientes:

Elementos de API relacionados

Se distribuye cuando se ha actualizado un objeto compartido remoto en el servidor.

Este evento tiene las propiedades siguientes:

Elementos de API relacionados