SharedObject  - AS3

Указывает объект, для которого вызываются методы ответного вызова. Объект по умолчанию: this. Если в свойстве client указать другой объект, методы обратного вызова будут вызываться на этом другом объекте.

Сборник атрибутов, связанных со свойством data объекта. Эти атрибуты можно совместно использовать и сохранять. Каждый атрибут может быть объектом любого типа ActionScript или JavaScript — массивом, числом, логическим значением, ByteArray, XML и т.п. Например, в следующих строках присваиваются значения различным аспектам общего объекта:

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

Все атрибуты свойства data общего объекта сохраняются, если объект обладает постоянством, при этом данный общий объект содержит следующую информацию:

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

Примечание. Не следует присваивать значения непосредственно свойству data общего объекта, например so.data = someValue, так как проигрыватель Flash Player игнорирует подобное присвоение.

Чтобы удалить атрибуты для локальных общих объектов, используйте код delete so.data.attributeName, так как установка значения null или undefined для атрибута локального общего объекта не приводит к удалению самого атрибута.

Чтобы создать значения private (значения, доступные только экземпляру клиента в процессе использования объекта и не сохраняемые при закрытии объекта) для общего объекта, создайте свойства, не называя их data, и сохраните их, как показано в следующем примере:

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

Общий объект содержит следующие данные:

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

Для удаленных общих объектов, используемых при работе с сервером, все атрибуты свойства data доступны всем клиентам, подключенным к общему объекту. При этом все атрибуты сохраняются, если объект обладает постоянством. Если один из клиентов изменит значение атрибута, то новое значение будет видно всем клиентам.

Связанные элементы API

Кодировка объекта по умолчанию (версия AMF) для всех локальных общих объектов, созданных в SWF-файле. Когда локальные общие объекты записываются на диск, свойство SharedObject.defaultObjectEncoding указывает необходимую версию формата Action Message Format: ActionScript 3.0 (AMF3), ActionScript 1.0 или 2.0 (AMF0).

Дополнительные сведения о кодировке объекта, включая различие между кодировкой в локальных и удаленных общих объектах, см. в описании свойства objectEncoding.

Значение SharedObject.defaultObjectEncoding по умолчанию: использование формата ActionScript 3.0 (AMF3). При необходимости записать локальные общие объекты, которые смогут быть прочитаны SWF-файлами ActionScript 2.0 или 1.0, настройте SharedObject.defaultObjectEncoding на использование формата ActionScript 1.0 или ActionScript 2.0, flash.net.ObjectEncoding.AMF0 (в начале сценария) до непосредственного создания таких объектов. Все локальные общие объекты, созданные после этого, будут использовать кодировку AMF0 и смогут взаимодействовать с более старым содержимым. После создания локальных общих объектов вы не сможете изменить значение objectEncoding существующих локальных общих объектов путем задания параметра SharedObject.defaultObjectEncoding.

Чтобы установить кодировку не для всех общих объектов, созданных SWF-файлов, а для отдельных объектов, установите свойство objectEncoding локального общего объекта.

Связанные элементы API

Определяет, сколько раз в секунду изменения общего объекта, внесенные клиентом, отправляются на сервер.

Используйте этот метод при необходимости управлять объемом данных, перемещаемых между клиентом и сервером. Например, если соединение между клиентом и сервером характеризуется относительно медленной скоростью, может потребоваться установить для параметра fps более низкое значение. И наоборот, если клиент подключен к многопользовательскому приложению, в котором важен расчет времени, можно установить для fps относительно высокое значение.

Настройка параметра fps приведет к появлению события sync и обновит все изменения на сервере. Если только требуется вручную обновить сервер, установите для fps значение 0.

Изменения не отправляются на сервер до тех пор, пока не будет отправлено событие sync. Другими словами, если время реагирования сервера слишком мало, обновления могут отправляться на сервер с меньшей частотой, чем значение, указанное в данном свойстве.

Кодировка объекта (версия AMF) для данного общего объекта. Когда локальный общий объект записывается на диск, свойство objectEncoding указывает необходимую версию формата Action Message Format: ActionScript 3.0 (AMF3), ActionScript 1.0 или 2.0 (AMF0).

Кодировка объекта обрабатывается в зависимости от типа общего объекта (локальный или удаленный).

• Локальные общие объекты. Вы можете получить или установить значение свойства objectEncoding для локальных общих объектов. Значение objectEncoding влияет на то, какое форматирование используется для записи данного локального общего объекта. Если этот локальный общий объект должен считываться SWF-файлами ActionScript 2.0 или 1.0, установите для objectEncoding значение ObjectEncoding.AMF0. Даже если запись должна вестись в кодировке объекта AMF3, проигрыватель Flash Player все равно способен считывать локальные общие объекты в кодировке AMF0. Другими словами, если используется значение данного свойства по умолчанию (ObjectEncoding.AMF3), SWF-файл все равно сможет считывать общие объекты, созданные SWF-файлами в формате ActionScript 2.0 или 1.0.
• Удаленные общие объекты. При подключении к серверу удаленный общий объект наследует его параметр objectEncoding от связанного экземпляра NetConnection (экземпляра, используемого для подключения к удаленному общему объекту). При отсутствии подключения к серверу удаленный общий объект наследует параметр defaultObjectEncoding от соответствующего экземпляра NetConnection. Поскольку значение свойства objectEncoding удаленного общего объекта определяется экземпляром NetConnection, для удаленных общих объектов это свойство является доступным только для чтения.

Связанные элементы API

Указывает, будет ли выполняться резервное копирование локальных общих объектов в облачной службе резервного копирования iOS.

Укажите значение true или false:

• true: предотвращает резервное копирование всех локальных общих объектов в облачной службе iOS.
• false (по умолчанию): выполняется резервное копирование локальных общих объектов в облачной службе iOS.

Это свойство применяется только к локальным общим объектам и только для ОС iOS.

Текущий размер общего объекта (в байтах).

Flash вычисляет размер общего объекта, просматривая свойства всех его данных. Чем больше свойств данных содержит объект, тем больше времени требуется для вычисления размера. Анализ размера объекта может занять существенный объем ресурсов, поэтому этот метод следует использовать только в случае особой необходимости.

import flash.net.SharedObject;

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

Удаляет все данные и удаляет общий объект с диска для локальных общих объектов. Ссылка на общий объект все еще активна, однако его свойства data удалены.

Для удаленных общих объектов, используемых при работе с Flash Media Server, метод clear() отключает объект и стирает все его данные. Если общий объект характеризуется локальным постоянством, данный метод также удаляет этот объект с диска. Ссылка на общий объект все еще активна, однако его свойства data удалены.

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

Закрывает подключение между удаленным общим объектом и сервером. Если удаленный общий объект имеет локальное постоянство, то после вызова данного метода пользователь сможет вносить изменения в локальную копию объекта. Любые изменения, внесенные в локальный объект, отправляются на сервер при следующем подключении пользователя к удаленному общему объекту.

Подключается к удаленному общему объекту на сервере с помощью указанного объекта NetConnection. Используйте данный метод после вызова getRemote(). При успешном подключении отправляется событие sync.

Перед тем как перейти к работе с удаленным общим объектом, прежде всего проверьте его на наличие ошибок с помощью оператора try..catch..finally. Перед тем как вносить какие-либо изменения в общий объект, необходимо прослушать и обработать событие sync. Любые изменения, внесенные локально до отправки события sync, могут быть потеряны.

Чтобы подключиться к удаленному общему объекту, вызовите метод connect(), например:

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

Параметры

Связанные элементы API

Немедленно записывает постоянный локальный общий объект в локальный файл. Если вы не используете данный метод, проигрыватель Flash Player записывает общий объект в файл по окончании соответствующего сеанса: когда SWF-файл закрывается, когда общий объект попадает в мусор, так как на него больше ничто не ссылается, а также когда вы вызываете SharedObject.clear() или SharedObject.close().

Если данный метод возвращает значение SharedObjectFlushStatus.PENDING, проигрыватель Flash Player отображает диалоговое окно, предлагающее пользователю увеличить объем дискового пространства, доступный для объектов из этого домена. Чтобы открыть пространство для роста общего объекта при его сохранении в будущем, что позволит избежать возвращенных значений PENDING, передайте значение для параметра minDiskSpace. При попытке записать файл проигрыватель Flash Player не проверяет наличие достаточного места для сохранения общего объекта в его текущем размере, а выясняет число байтов, переданных minDiskSpace.

Например, если вы предполагаете, что при росте максимальный размер общего объекта составит 500 байтов (хотя в начале он будет намного меньшим), установите для minDiskSpace значение 500. Когда Flash запрашивает у пользователя возможность выделить дисковое пространство для общего объекта, объем запроса составляет 500 байт. После того как пользователь выделяет требуемый объем пространства, Flash больше не запрашивает дополнительное пространство в последующих попытках очистки объекта (его размер при этом не должен превышать 500 байт).

Данный метод вызывается снова после того, как пользователь отреагирует на диалоговое окно. Событие netStatus отправляется со свойством code, имеющим значение SharedObject.Flush.Success или SharedObject.Flush.Failed.

Параметры

Связанные элементы API

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

Возвращает ссылку на постоянный локальный общий объект, доступный только для текущего клиента. Данный метод создает общий объект, если таковой не существовал ранее. Если любые значения, переданные методу getLocal(), являются недопустимыми или вызов завершился сбоем, Flash Player создает соответствующее исключение.

В представленном коде показано, как присвоить переменной возвращенную ссылку на общий объект:

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

Примечание. Если пользователь запретил локальное хранение для данного домена, объект не будет сохраняться локально, даже если определено значение для параметра localPath. Исключением для данного правила является локальное содержимое. Локальное содержимое всегда может записывать на диск общие объекты из сторонних доменов (доменов, отличающихся от домена, указанного в данный момент в адресной строке обозревателя), даже если запись сторонних общих объектов на диск запрещена.

Чтобы избежать конфликта имен, проигрыватель Flash отслеживает место размещения SWF-файла, создающего общий объект. Например, если SWF-файл на сайте www.myCompany.com/apps/stockwatcher.swf создает общий объект portfolio, то данный общий объект не конфликтует с другим объектом portfolio, который был создан SWF-файлом на сайте www.yourCompany.com/photoshoot.swf, так как эти SWF-файлы находятся в разных каталогах.

Несмотря на то, что параметр localPath не является обязательным, ему можно найти применение, особенно в тех случаях, когда доступ к общему объекту требуется и другим SWF-файлам. Если данные в общем объекте специфичны для одного SWF-файла, который не будет перемещен в другое место, то целесообразнее использовать значение по умолчанию. Если доступ к общему объекту нужен другим SWF-файлам или если SWF-файл, создающий общий объект, будет впоследствии перемещен, то значение этого параметра определенно влияет на доступность общего объекта. Например, если вы создадите общий объект, у которого параметр localPath будет иметь значение по умолчанию (полный путь к SWF-файлу), то данный общий объект будет недоступен каким-либо другим SWF-файлам. Если вы позднее переместите исходный SWF-файл в другое место, то даже этому SWF-файлу не будут доступны данные, которые уже были сохранены в общем объекте.

Чтобы избежать непреднамеренного ограничения доступа к общему объекту, используйте параметр localpath. Наиболее демократичный подход заключается в установке localPath со значением / (косая черта). В этом случае общий объект становится доступным всем SWF-файлам в домене, но при этом увеличивается вероятность возникновения конфликтов имен с другими общими объектами в домене. При подходе ограничивающего характера в localPath добавляются имена папок, представляющих полный путь к SWF-файлу. Например, для общего объекта portfolio, созданного SWF-файлом по адресу www.myCompany.com/apps/stockwatcher.swf, можно установить параметр localPath со значением /, /apps или /apps/stockwatcher.swf. Следует определить, какой подход обеспечивает оптимальную гибкость для вашего приложения.

При использовании данного метода необходимо учесть следующую модель безопасности:

• Доступ к общим объектам через границы изолированных программных сред запрещен.
• Пользователи могут ограничить доступ к общим объектам с помощью диалогового окна Flash Player Settings или диспетчера настроек. По умолчанию приложение может создавать общие объекты размером до 100 килобайт данных на один домен. Администраторы и пользователи также могут устанавливать ограничения на возможность записи данных в файловой системе.

Предположим, вы публикуете содержимое SWF-файла, которое должно воспроизводиться как локальные файлы (локально установленные SWF-файлы или EXE-файлы). При этом вам необходимо, чтобы определенный общий объект был доступен для нескольких локальных SWF-файлов. В этой ситуации не забудьте, что для хранения локальных общих объектов могут использоваться два разных места. Выбор используемого домена зависит от разрешений безопасности, предоставленных локальному файлу, который создал общий объект. Локальные файлы могут иметь три разных уровня полномочий (разрешений):

1. Предоставлен доступ только к локальной файловой системе.
2. Предоставлен доступ только к сети.
3. Предоставлен доступ как к сети, так и локальной файловой системе.

Локальные файлы, имеющие доступ к локальной файловой системе (уровень 1 или 3), хранят свои общие объекты в одном месте. Локальные файлы, не имеющие доступа к локальной файловой системе (2 уровень), хранят свои общие объекты в другом месте.

Можно запретить использование SWF-файлом этого метода путем установки параметра allowNetworking для тегов object и embed на странице HTML, содержащей SWF-содержимое.

Для получения дополнительной информации см. раздел центра разработчиков Flash Player Безопасность.

Параметры

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

Возвращает ссылку на общий объект на сервере Flash Media Server, доступный нескольким клиентам. Данный метод создает удаленный общий объект, если таковой не существовал ранее.

Чтобы создать удаленный общий объект, вызовите getRemote(), а затем connect() для подключения удаленного объекта к серверу, как в следующем примере:

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

Чтобы убедиться в том, что локальная и удаленная копии общего объекта синхронизированы, следует прослушать и обработать событие sync. Все клиенты, которые хотят совместно использовать этот объект, должны передать одинаковые значения для параметров name и remotePath.

Чтобы создать общий объект, который будет доступен только текущему клиенту, используйте метод SharedObject.getLocal().

Параметры

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

Связанные элементы API

Транслирует сообщение всем клиентам, подключенным к удаленному общему объекту (включая клиента, отправляющего сообщение). Чтобы обработать и отреагировать на данное сообщение, вызовите функцию обратного вызова, прикрепленную к общему объекту.

Параметры

Указывает серверу, что значение свойства в общем объекте было изменено. Данный метод помечает свойства флагом изменения dirty.

Вызовите SharedObject.setProperty(), чтобы создать свойства общего объекта.

Метод SharedObject.setProperty() реализует setDirty(). В большинстве случаев, например, когда значение свойства представлено примитивным типом (строка или число), вместо setDirty() можно вызвать setProperty(). Однако если значением свойства является объект, содержащий свои собственные свойства, вызовите setDirty(), чтобы указать, когда значение изменяется в рамках объекта.

Параметры

Связанные элементы API

Обновляет значение свойства в общем объекте и указывает серверу, что значение свойства было изменено. Метод setProperty() явно отмечает свойства как измененные или имеющие не сохраненные данные.

Дополнительные сведения об удаленных общих объектах см. в документации Flash Media Server.

Примечание. Метод SharedObject.setProperty() реализует метод setDirty(). В большинстве случаев, например, когда значение свойства представлено примитивным типом (строка или число), вместо setDirty() можно вызвать setProperty(). Однако если значением свойства является объект, содержащий свои собственные свойства, используйте setDirty(), чтобы указать, когда значение изменяется в рамках объекта. Вообще, рекомендуется вместо setDirty() вызывать setProperty(), так как setProperty() обновляет значение свойства только при изменении этого значения, в то время как setDirty() принудительно выполняет синхронизацию на всех подписанных клиентах.

Параметры

Связанные элементы API

Отправляется, когда исключение создается асинхронным образом, то есть в коде, изначально имеющем асинхронную природу.

Это событие имеет следующие свойства:

Отправляется, когда экземпляр SharedObject сообщает о своем состоянии или о случившейся ошибке. Событие netStatus содержит свойство info, представляющее собой информационный объект, в котором размещаются специфические сведения о событии: успешность попытки подключения или успешность записи общего объекта на локальный диск.

Это событие имеет следующие свойства:

Связанные элементы API

Отправляется, когда удаленный общий объект обновляется сервером.

Это событие имеет следующие свойства:

Связанные элементы API