コールバックメソッドが呼び出されるオブジェクトを示します。デフォルトのオブジェクトは 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
  

メモ:so.data = someValue というように、共有オブジェクトの data プロパティに値を直接割り当てないでください。このような割り当ては無視されます。

ローカル共有オブジェクトの属性を削除するには、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]
  

関連項目

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

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

関連項目

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

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

更新の送信時に手動で制御する場合、変更をサーバーに送る場合は fps を 0 に設定します。たとえば、ユーザーがサーバーに更新を送るボタンを押すようにする場合は、ボタンに myRemoteSharedObject.fps(0) を追加します。

fps に渡す値に関わらず、sync 実装
    public function set fps(value:Number):void

この共有オブジェクトのエンコード (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 ファイルで作成した共有オブジェクトをSFW ファイルで読み込むことができます。
• リモート共有オブジェクト。サーバーに接続されているときは、リモート共有オブジェクトは、関連付けされた NetConnection インスタンス (リモート共有オブジェクトへの接続に使用されるインスタンス) から objectEncoding 設定を継承します。サーバーに接続されていないときは、リモート共有オブジェクトは、関連付けされた NetConnection インスタンスから defaultObjectEncoding 設定を継承します。

  リモート共有オブジェクトの objectEncoding プロパティの値は NetConnection インスタンスにより決定されるため、このプロパティはリモート共有オブジェクトの読み取り専用になります。

関連項目

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

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

関連項目

import flash.net.SharedObject;

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

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

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

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

リモート共有オブジェクトとサーバーとの間の接続を閉じます。リモート共有オブジェクトがローカルに永続化されている場合、ユーザーはこのメソッドの呼び出し後に、オブジェクトのローカルコピーを変更できます。ローカルオブジェクトの変更は、次回にユーザーがリモート共有オブジェクトに接続したときに、サーバーに送られます。

指定された接続を介して、サーバー上のリモート共有オブジェクトに接続します。このメソッドは SharedObject.getRemote() の発行後に使用します。接続が成功すると、sync イベントが送出されます。

リモート共有オブジェクトを使用する前に、まず接続の成功を示す true の戻り値をチェックし、sync イベントが送出されるまで待機します。これを行わないと、sync イベントが送出される前に、ローカルで行ったオブジェクトの変更が失われる可能性があります。

メモ:この呼び出しが false を返した場合、sync イベントは送出されません。

関連項目

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

このメソッドが SharedObjectFlushStatus.PENDING を返した場合は、Flash Player では、このドメインからのオブジェクトを保存するためのディスク領域を増やすように求めるダイアログボックスが表示されます。将来的に共有オブジェクトを保存する際に、領域が自動的に拡張されるようにする (PENDING が返されないようにする) には、minDiskSpace に値を指定します。ファイルにオブジェクトを書き込む際には、現在のサイズの共有オブジェクトを保存するために十分な領域だけではなく、minDiskSpace に指定したバイト数が確認されます。

たとえば、共有オブジェクトが最初は小さくても後から最大で 500 バイトまで増えると予想される場合には、minDiskSpace に 500 を指定します。ユーザーに対して共有オブジェクトへのディスク領域の割り当てを求める際には、500 バイトの領域が要求されます。要求されたディスク領域をユーザーが割り当てた場合、それ以降、オブジェクトのサイズが 500 バイトを超えない限り、オブジェクトを保存する際に追加のディスク領域を要求されることはありません。

ユーザーがこのダイアログボックスに応答した後、このメソッドがもう一度呼び出され、netStatus イベントが、SharedObject.Flush.Success または SharedObject.Flush.Failed の code プロパティを使用して送出されます。

関連項目

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 に SFW ファイルへの完全パス内のフォルダ名を付加する方法です。たとえば、www.myCompany.com/apps/stockwatcher.swf にある SWF ファイルで作成された portfolio 共有オブジェクトの場合は、localPath パラメータを /、/apps、または /apps/stockwatcher.swf に設定できます。アプリケーションに最適な柔軟性を提供できる方法がどれかを判断する必要があります。

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

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

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

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

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

詳細については、次のトピックを参照してください。

• 『ActionScript 3.0 のプログラミング』のセキュリティの章と LiveDocs の最新コメント
• Flash Player 9 セキュリティに関するホワイトペーパー

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

関連項目

何らかのサーバー (Flash Media Server など) によって複数クライアントでの共有ができるオブジェクトへの参照を返します。共有オブジェクトがまだ存在しない場合は、このメソッドにより作成されます。

次のコードでは、返された共有オブジェクトの参照の変数への割り当て方法を示します。

var myRemote_so:SharedObject = SharedObject.getRemote(name, remotePath, persistence);

現在のクライアントでのみ利用できる共有オブジェクトを作成するには、SharedObject.getLocal() を使用します。

次のコードに示すように、このメソッドの呼び出し後に SharedObject.connect() を使用して、オブジェクトをアプリケーションサーバーに接続します。

     var myNC:NetConnection = new NetConnection();
     myNC.connect("rtmp://[yourDomain].com/applicationName");
     var myRemoteSO:SharedObject = SharedObject.getRemote("mo", myNC.uri, false);
     myRemoteSO.connect(myNC);
     

共有オブジェクトのローカルおよびリモートコピーを同期させるには、sync イベントを使用します。

このオブジェクトを共有するすべてのクライアントは、name パラメータと remotePath パラメータに同じ値を渡す必要があります。リモート共有オブジェクトの詳細については、Flash Media Server のマニュアルの SharedObject.getRemote() を参照してください。

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

関連項目

指定されたリモート共有オブジェクトに接続しているすべてのクライアント (メッセージを送信したクライアントも含む) に、メッセージをブロードキャストします。メッセージを処理し応答するには、共有オブジェクトに送信するハンドラ関数を作成します。

共有オブジェクトのプロパティの値 (data プロパティで定義) が変更されたことをサーバーに通知します。このメソッドは、プロパティを変更済み (ダーティ) としてマークし、サーバーサイド ActionScript で使用します。

共有オブジェクトのプロパティを作成するには、SharedObject.data プロパティを使用するか、単純に SharedObject プロパティという一意の名前を付けた新しいプロパティを作成します。これらの 2 つの方法の違いの詳細については、SharedObject.data プロパティを参照してください。

SharedObject.setProperty() メソッドには、setDirty() メソッドが実装されています。ほとんどの場合、たとえばプロパティの値がストリングや数値などのプリミティブ型の場合などは、setDirty() ではなく、setProperty() を使用します。ただし、プロパティの値が独自のプロパティを持つオブジェクトである場合は、setDirty() を使用してオブジェクト内の値が変更された日時を示します。

関連項目

共有オブジェクトのプロパティの値 (data プロパティで定義) を更新し、サーバーにプロパティの値が変更されたことを示します。setProperty() メソッドは、プロパティを変更済み (ダーティ) として明示的にマークし、サーバーサイド ActionScript で使用します。Flash Media Server などのサーバーには、setProperty() を明示的に呼び出して、共有オブジェクトのプロパティが変更された日時を示す必要があるものもあります。

SharedObject.setProperty() をサーバーサイドで呼び出した場合、共有オブジェクトを使用しているすべての Flash Player クライアントに対して、クライアントサイドで sync イベントを通じて変更通知が呼び出されます。サーバーサイドの propertyName パラメータは、クライアントサイドの data プロパティの属性と同じです。たとえば、次のコード行はすべて同じです。最初の 2 行はサーバーサイド ActionScript で、3、4 行目はクライアントサイド ActionScript です。

  setProperty("nameVal", "foo");
  setDirty("nameVal");
  data["nameVal"] = "foo";
  data.nameVal = "foo";
  

Flash Media Server のユーザーは、「 Flash Media Server Server-Side ActionScript Language Reference」で、サーバーサイド ActionScript およびリモート共有オブジェクトに関する詳細を参照できます。

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

関連項目

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

AsyncErrorEvent.ASYNC_ERROR 定数は、asyncError イベントオブジェクトの type プロパティ値を定義します。

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

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

netStatus イベントオブジェクトの type プロパティの値を定義します。

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

関連項目

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

sync イベントオブジェクトの type プロパティの値を定義します。

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

関連項目