SharedObject  - AS3

コールバックメソッドが呼び出されるオブジェクトを示します。デフォルトのオブジェクトは this です。client プロパティを別のオブジェクトに設定し、コールバックメソッドをその別のオブジェクトで呼び出すことができます。

オブジェクトの data プロパティに割り当てられた属性のコレクションです。これらの属性は共有および保存することができます。それぞれの属性は、ActionScript または JavaScript タイプのオブジェクトです。例えば、Array、Number、Boolean、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 のように値を直接割り当てないようにしてください。このような割り当ては無視されます。

ローカル共有オブジェクトの属性を削除するには、delete so.data.attributeName というコードを使用します。ローカル共有オブジェクトの属性を null または undefined に設定しても、属性は削除されません。

共有オブジェクトのプライベート値（オブジェクトの使用中にそのクライアントインスタンスでのみ利用でき、閉じるときにオブジェクトと共に保存されない値）を作成するには、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 エレメント

SWF ファイルで作成されたすべてのローカル共有オブジェクトのデフォルトのオブジェクトエンコード（AMF バージョン）です。ローカル共有オブジェクトがディスクに書き込まれるとき、SharedObject.defaultObjectEncoding プロパティは、使用する必要のある Action Message Format バージョンを示します。ActionScript 3.0 フォーマット（AMF3）または ActionScript 1.0 または 2.0 フォーマット（AMF0）です。

ローカル共有オブジェクトとリモート共有オブジェクトのエンコードの違いを含む、オブジェクトエンコードの詳細については、objectEncoding プロパティの説明を参照してください。

SharedObject.defaultObjectEncoding のデフォルト値は、ActionScript 3.0 フォーマット AMF3 を使用するように設定されています。ActionScript 2.0 または 1.0 SWF ファイルで読み込めるローカル共有オブジェクトの書き込みが必要な場合は、ローカル共有オブジェクトを作成する前に、スクリプトの先頭部分で SharedObject.defaultObjectEncoding を設定して、ActionScript 1.0 または ActionScript 2.0 フォーマット flash.net.ObjectEncoding.AMF0 を使用するようにします。それ以降に作成されるすべてのローカル共有オブジェクトで、AMF0 エンコーディングが使用され、古いコンテンツとやり取りできるようになります。ローカル共有オブジェクトを作成した後は、既存のローカル共有オブジェクトの objectEncoding 値を SharedObject.defaultObjectEncoding を設定して変更することはできません。

SWF ファイルで作成したすべての共有オブジェクトに対してではなく、オブジェクトごとにオブジェクトエンコードを設定するには、ローカル共有オブジェクトの objectEncoding プロパティを設定します。

関連する API エレメント

共有オブジェクトに対するクライアントの変更がサーバーに送信される回数（1 秒あたり）を指定します。

クライアントとサーバー間のトラフィック量を制限する場合に、このメソッドを使用します。例えば、クライアントとサーバー間の接続が比較的遅い場合は、fps を小さめの値に設定するとよいでしょう。逆に、クライアントが、タイミングが重要なマルチユーザーアプリケーションに接続している場合は、fps をやや大きめの値に設定できます。

fps を設定すると、sync イベントがトリガーされ、サーバーに対するすべての変更が更新されるようになります。サーバーを手動のみで更新する場合は、fps を 0 に設定します。

sync イベントが送出されるまで、サーバーに変更は送信されません。つまり、サーバーからの応答時間が遅い場合、更新がサーバーに送られる頻度は、このプロパティに指定した値よりも少なくなる可能性があります。

この共有オブジェクトのオブジェクトエンコード（AMF バージョン）です。ローカル共有オブジェクトがディスクに書き込まれるとき、objectEncoding プロパティは、使用する必要のある Action Message Format バージョンを示します。ActionScript 3.0 フォーマット（AMF3）または ActionScript 1.0 または 2.0 フォーマット（AMF0）です。

オブジェクトエンコードは、共有オブジェクトがローカルかリモートかによって、処理方法が異なります。

• ローカル共有オブジェクト。ローカル共有オブジェクトの objectEncoding プロパティの値を取得または設定できます。objectEncoding の値は、このローカル共有オブジェクトの書き込み に使用されるフォーマットに影響します。このローカル共有オブジェクトを ActionScript 2.0 または 1.0 SWF ファイルで読み込めなければならない場合は、objectEncoding を ObjectEncoding.AMF0 に設定します。オブジェクトエンコードが AMF3 を書き込むように設定されていても、Flash Player で AMF0 ローカル共有オブジェクトを読み込むことができます。つまり、このプロパティのデフォルト値（ObjectEncoding.AMF3）を使用すれば、ActionScript 2.0 または 1.0 SWF ファイルで作成した共有オブジェクトも引き続き SWF ファイルで読み込むことができます。
• リモート共有オブジェクト。サーバーに接続されているときは、リモート共有オブジェクトは、関連付けられた NetConnection インスタンス（リモート共有オブジェクトへの接続に使用されるインスタンス）の objectEncoding 設定を継承します。サーバーに接続されていないときは、リモート共有オブジェクトは、関連付けされた NetConnection インスタンスから defaultObjectEncoding 設定を継承します。リモート共有オブジェクトの objectEncoding プロパティの値は NetConnection インスタンスにより決定されるため、このプロパティはリモート共有オブジェクトでは読み取り専用になります。

関連する API エレメント

ローカル共有オブジェクトが iOS のクラウドバックアップサービスでバックアップされるかどうかを指定します。

true または false を指定します。

• true - すべてのローカル共有オブジェクトが iOSのバックアップクラウドサービスでバックアップされないようにします。
• false（デフォルト） - ローカル共有オブジェクトが iOS のバックアップクラウドサービスでバックアップされます。

このプロパティは、ローカル共有オブジェクトのみに適用され、iOS にのみ使用できます。

共有オブジェクトの現在のサイズ（バイト数）です。

すべてのデータプロパティを順に確認することによって、共有オブジェクトのサイズが計算されます。オブジェクトが持つデータプロパティが多いほど、サイズの計算に時間がかかります。オブジェクトのサイズを調べる処理は非常に時間がかかる場合があるので、特に必要がない限り、このメソッドの使用は避けてください。

import flash.net.SharedObject;

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

ローカル共有オブジェクトの場合、すべてのデータを消去し、共有オブジェクトをディスクから削除します。共有オブジェクトへの参照はアクティブなままで、そのデータプロパティが削除されます。

Flash Media Server で使用されるリモート共有オブジェクトの場合、clear() はオブジェクトを切断し、すべてのデータを削除します。共有オブジェクトがローカルに永続化されている場合、このメソッドによって共有オブジェクトもディスクから削除されます。共有オブジェクトへの参照はアクティブなままで、そのデータプロパティが削除されます。

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 エレメント

ローカルに永続化された共有オブジェクトを直ちにローカルファイルに書き込みます。このメソッドを使用しない場合、共有オブジェクトがファイルに書き込まれるのは、共有オブジェクトセッションの終了時となります。つまり、SWF ファイルが閉じられるとき、共有オブジェクトが参照されなくなってガベージコレクションされるとき、SharedObject.clear() または SharedObject.close() が呼び出されたとき、のいずれかの時点です。

このメソッドが SharedObjectFlushStatus.PENDING を返した場合、このドメインからのオブジェクトを保存するためのディスク領域を増やすようユーザーに求めるダイアログボックスが表示されます。共有オブジェクトが保存されるときはそのための領域を大きくして PENDING が返されないようにするには、minDiskSpace に値を指定します。Flash Player は、ファイルを書き込む際、現在のサイズの共有オブジェクトを保存するのに必要な領域ではなく、minDiskSpace に指定されたバイト数を確認します。

例えば、共有オブジェクトのサイズが、最初は小さくても最大 500 バイトまで大きくなると予想される場合には、minDiskSpace に 500 を指定します。ユーザーに対して共有オブジェクトへのディスク領域の割り当てを求める際には、500 バイトの領域が要求されます。要求されたディスク領域をユーザーが割り当てた場合、それ以降、オブジェクトのサイズが 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 の値が指定されていても、オブジェクトはローカルに保存されません。ただし、ローカルコンテンツは例外です。サードパーティードメイン（現在のブラウザーのアドレスバーにあるドメイン以外のドメイン）の共有オブジェクトのディスクへの書き込みを許可していない場合でも、ローカルコンテンツでは、常にサードパーティードメインの共有オブジェクトをディスクに書き込むことができます。

名前のコンフリクトを避けるために、共有オブジェクトを作成している SWF ファイルの位置が考慮されます。例えば、www.myCompany.com/apps/stockwatcher.swf にある SWF ファイルが portfolio という名前の共有オブジェクトを作成した場合、この共有オブジェクトは、www.yourCompany.com/photoshoot.swf にある SWF ファイルが作成した portfolio という別のオブジェクトとは競合しません。これは、この 2 つの SWF ファイルが異なるディレクトリに置かれているからです。

localPath パラメーターはオプションですが、慎重に使用する必要があります。特に、他の SWF ファイルが共有オブジェクトにアクセスしなければならない場合には注意してください。共有オブジェクトのデータが、別の場所に移動されない 1 つの SWF ファイルに固有のものである場合は、デフォルト値を使用することをお勧めします。他の SWF ファイルが共有オブジェクトにアクセスする必要がある場合、または共有オブジェクトを作成する SWF ファイルを後で移動する場合には、このパラメーターの値により、共有オブジェクトへのアクセスに影響が生じます。例えば、localPath をデフォルト値である SWF ファイルの完全パスに設定して共有オブジェクトを作成すると、他の SWF ファイルはその共有オブジェクトにアクセスできません。元の SWF ファイルを後で別の場所に移動すると、その SWF ファイルからも、共有オブジェクトに格納されているデータにアクセスできなくなります。

共有オブジェクトへのアクセスを誤って制限してしまうのを避けるには、localpath パラメーターを使用します。最も制限の緩やかな方法は、localPath を /（スラッシュ）に設定する方法です。ドメインのすべての SWF ファイルが共有オブジェクトを利用できますが、ドメイン内の他の共有オブジェクトとの名前のコンフリクトが起こりやすくなります。より制限の厳しい方法は、localPath に SWF ファイルへの完全パス内のフォルダー名を付加する方法です。例えば、www.myCompany.com/apps/stockwatcher.swf にある SWF ファイルで作成された portfolio 共有オブジェクトの場合は、localPath パラメーターを /、/apps、または /apps/stockwatcher.swf に設定できます。アプリケーションに最適な柔軟性を提供できる方法がどれかを判断する必要があります。

このメソッドを使用するときは、次のセキュリティモデルを考慮してください。

• サンドボックスの境界を越えて共有オブジェクトにアクセスすることはできません。
• Flash Player の設定ダイアログボックスまたは設定マネージャーを使用して、共有オブジェクトへのアクセスを制限できます。デフォルトでは、アプリケーションでドメインごとに最大 100 KB の共有オブジェクトを作成できます。管理者および一般ユーザーは、ファイルシステムへの書き込み機能に制限を適用することもできます。

ローカルファイル（ローカルにインストールされた SWF ファイルまたは EXE ファイル）として再生する SWF ファイルコンテンツをパブリッシュし、複数のローカル SWF ファイルから特定の共有オブジェクトにアクセスする必要があるとします。この状況では、ローカルファイルでは共有オブジェクトの保存に 2 つの異なる場所が使用されることがあるので注意してください。使用されるドメインは、共有オブジェクトを作成したローカルファイルに付与されるセキュリティ許可によって変わります。ローカルファイルには、次の 3 つの異なる許可レベルを設定できます。

1. ローカルファイルシステムのみに対するアクセス
2. ネットワークのみに対するアクセス
3. ネットワークとローカルファイルシステムの両方に対するアクセス

ローカルファイルシステムへのアクセス権を持つローカルファイル（レベル 1 または 3）は、共有オブジェクトを 1 つの場所に格納します。ローカルファイルシステムへのアクセス権を持たないローカルファイル（レベル 2）は、共有オブジェクトを別の場所に格納します。

SWF ファイルがこのメソッドを使用しないようにするには、SWF コンテンツを含んでいる HTML ページに allowNetworking パラメーター（object タグおよび embed タグのパラメーター）を設定します。

詳細については、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() を実装します。ほとんどの場合、例えばプロパティの値がストリングや数値のようなプリミティブ型のときは、setProperty() を呼び出すことが可能で、setDirty() を呼び出す必要はありません。ただし、プロパティの値が独自のプロパティを持つオブジェクトである場合は、setDirty() を呼び出してオブジェクト内の値が変更された日時を示します。

パラメーター

関連する API エレメント

共有オブジェクトのプロパティの値を更新し、プロパティの値が変更されたことをサーバーに通知します。setProperty() メソッドは、プロパティを changed または dirty として明示的にマークします。

リモート共有オブジェクトの詳細については、Flash Media Server のマニュアルを参照してください。

注意：SharedObject.setProperty() メソッドには、setDirty() メソッドが実装されています。ほとんどの場合、例えばプロパティの値がストリングや数値のようなプリミティブ型のときは、setProperty() を使用し、setDirty を使用することはありません。ただし、プロパティの値が独自のプロパティを持つオブジェクトである場合は、setDirty() を使用してオブジェクト内の値が変更された日時を示します。一般的には、setProperty() を呼び出して、setDirty() は使用しないことをお勧めします。setProperty() は値が変更されたときだけプロパティ値を更新しますが、setDirty() はサブスクライブしているすべてのクライアントを強制的に同期させるからです。

パラメーター

関連する API エレメント

非同期形式で、つまりネイティブ非同期コードから例外がスローされると送出されます。

このイベントには、次のプロパティがあります。

SharedObject インスタンスが、そのステータスまたはエラーの状況をレポートするときに送出されます。netStatus イベントには、info プロパティが含まれます。このプロパティは、接続試行が成功したかどうかや共有オブジェクトのローカルディスクへの書き込みが成功したかどうかなど、イベントに関する特定の情報を含む情報オブジェクトです。

このイベントには、次のプロパティがあります。

関連する API エレメント

リモート共有オブジェクトがサーバーによって更新されるときに送出されます。

このイベントには、次のプロパティがあります。

関連する API エレメント