| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| |
| --> |
| <apiPackage id="mx.messaging.errors"><apiName>mx.messaging.errors</apiName><apiDetail/><apiClassifier id="mx.messaging.errors:InvalidChannelError"><apiName>InvalidChannelError</apiName><shortdesc> |
| このエラーは、チャンネルがアクセス不能か、現在の宛先に対して有効でない場合にスローされます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseClassifier>mx.messaging.errors:ChannelError</apiBaseClassifier></apiClassifierDef><apiDesc> |
| このエラーは、チャンネルがアクセス不能か、現在の宛先に対して有効でない場合にスローされます。 このエラーは、フレームワーク内の以下のメソッドまたはプロパティによってスローされます。 |
| <ul> |
| <li><codeph>ServerConfig.getChannel()</codeph> で、チャンネル ID に基づくチャンネルが見つからない場合。</li> |
| </ul> |
| |
| </apiDesc></apiClassifierDetail><apiConstructor id="mx.messaging.errors:InvalidChannelError:InvalidChannelError"><apiName>InvalidChannelError</apiName><shortdesc> |
| 指定されたメッセージを持つ新しい InvalidChannelError インスタンスを作成します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/><apiParam><apiItemName>msg</apiItemName><apiType value="String"/><apiDesc>この InvalidChannelError を説明するメッセージが含まれるストリング。 |
| |
| </apiDesc></apiParam></apiConstructorDef><apiDesc> |
| 指定されたメッセージを持つ新しい InvalidChannelError インスタンスを作成します。 |
| |
| </apiDesc></apiConstructorDetail></apiConstructor></apiClassifier><apiClassifier id="mx.messaging.errors:InvalidDestinationError"><apiName>InvalidDestinationError</apiName><shortdesc> |
| このエラーは、宛先がアクセス不能か、有効でない場合にスローされます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseClassifier>mx.messaging.errors:ChannelError</apiBaseClassifier></apiClassifierDef><apiDesc> |
| このエラーは、宛先がアクセス不能か、有効でない場合にスローされます。 このエラーは、フレームワーク内の以下のメソッドまたはプロパティによってスローされます。 |
| <ul> |
| <li><codeph>ServerConfig.getChannelSet()</codeph> で、無効な宛先が指定された場合。</li> |
| <li><codeph>ServerConfig.getProperties()</codeph> で、無効な宛先が指定された場合。</li> |
| <li><codeph>Channel.send()</codeph> で、送信するメッセージに宛先が指定されていない場合。</li> |
| <li><codeph>MessageAgent.destination</codeph> の setter で、宛先の値が null または長さが 0 の場合。</li> |
| <li><codeph>Producer.send()</codeph> で、プロデューサまたは送信するメッセージに宛先が指定されていない場合。</li> |
| <li><codeph>Consumer.subscribe()</codeph> で、コンシューマに宛先が指定されていない場合。</li> |
| </ul> |
| |
| </apiDesc></apiClassifierDetail><apiConstructor id="mx.messaging.errors:InvalidDestinationError:InvalidDestinationError"><apiName>InvalidDestinationError</apiName><shortdesc> |
| 指定されたメッセージを持つ新しい InvalidDestinationError インスタンスを作成します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/><apiParam><apiItemName>msg</apiItemName><apiType value="String"/><apiDesc>この InvalidDestinationError を説明するメッセージが含まれるストリング。 |
| |
| </apiDesc></apiParam></apiConstructorDef><apiDesc> |
| 指定されたメッセージを持つ新しい InvalidDestinationError インスタンスを作成します。 |
| |
| </apiDesc></apiConstructorDetail></apiConstructor></apiClassifier><apiClassifier id="mx.messaging.errors:MessageSerializationError"><apiName>MessageSerializationError</apiName><shortdesc> |
| このエラーは、チャンネル内でのメッセージの直列化に関して問題が発生したことを示します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseClassifier>mx.messaging.errors:MessagingError</apiBaseClassifier></apiClassifierDef><apiDesc> |
| このエラーは、チャンネル内でのメッセージの直列化に関して問題が発生したことを示します。 これにより、このエラーがスローされたときに生成される ErrorMessage に対応する fault プロパティが提供されます。 |
| |
| </apiDesc></apiClassifierDetail><apiConstructor id="mx.messaging.errors:MessageSerializationError:MessageSerializationError"><apiName>MessageSerializationError</apiName><shortdesc> |
| 指定されたメッセージを持つ新しい MessageSerializationError インスタンスを作成します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/><apiParam><apiItemName>msg</apiItemName><apiType value="String"/><apiDesc>エラーを説明するメッセージが含まれるストリング。 |
| </apiDesc></apiParam><apiParam><apiItemName>fault</apiItemName><apiOperationClassifier>mx.messaging.messages:ErrorMessage</apiOperationClassifier><apiDesc>発生した障害と、障害がどのメッセージに対して発生したかに関する固有の情報を提供します。 |
| |
| </apiDesc></apiParam></apiConstructorDef><apiDesc> |
| 指定されたメッセージを持つ新しい MessageSerializationError インスタンスを作成します。 |
| |
| </apiDesc></apiConstructorDetail></apiConstructor><apiValue id="mx.messaging.errors:MessageSerializationError:fault"><apiName>fault</apiName><shortdesc> |
| 発生した障害と、障害がどのメッセージに対して発生したかに関する具体的な情報を提供します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueClassifier>mx.messaging.messages:ErrorMessage</apiValueClassifier></apiValueDef><apiDesc> |
| 発生した障害と、障害がどのメッセージに対して発生したかに関する具体的な情報を提供します。 |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier id="mx.messaging.errors:ChannelError"><apiName>ChannelError</apiName><shortdesc> |
| これは、すべてのチャンネル関連エラーの基本クラスです。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseClassifier>mx.messaging.errors:MessagingError</apiBaseClassifier></apiClassifierDef><apiDesc> |
| これは、すべてのチャンネル関連エラーの基本クラスです。 catch コードがそれほど詳細でなくてもかまいません。 |
| |
| </apiDesc></apiClassifierDetail><apiConstructor id="mx.messaging.errors:ChannelError:ChannelError"><apiName>ChannelError</apiName><shortdesc> |
| 指定されたメッセージを持つ新しい ChannelError インスタンスを作成します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/><apiParam><apiItemName>msg</apiItemName><apiType value="String"/><apiDesc>エラーを説明するメッセージが含まれるストリング。 |
| |
| </apiDesc></apiParam></apiConstructorDef><apiDesc> |
| 指定されたメッセージを持つ新しい ChannelError インスタンスを作成します。 |
| |
| </apiDesc></apiConstructorDetail></apiConstructor></apiClassifier><apiClassifier id="mx.messaging.errors:NoChannelAvailableError"><apiName>NoChannelAvailableError</apiName><shortdesc> |
| このエラーは、メッセージの送信に使用できるチャンネルが存在しない場合にスローされます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseClassifier>mx.messaging.errors:MessagingError</apiBaseClassifier></apiClassifierDef><apiDesc> |
| このエラーは、メッセージの送信に使用できるチャンネルが存在しない場合にスローされます。 このエラーは、フレームワーク内の以下のメソッドによってスローされます。 |
| <ul> |
| <li><codeph>ChannelSet.send()</codeph> で、ChannelSet にチャンネルがない場合。</li> |
| </ul> |
| |
| </apiDesc></apiClassifierDetail><apiConstructor id="mx.messaging.errors:NoChannelAvailableError:NoChannelAvailableError"><apiName>NoChannelAvailableError</apiName><shortdesc> |
| 指定されたメッセージを持つ新しい NoChannelAvailableError インスタンスを作成します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/><apiParam><apiItemName>msg</apiItemName><apiType value="String"/><apiDesc>この NoChannelAvailableError を説明するメッセージが含まれるストリング。 |
| |
| </apiDesc></apiParam></apiConstructorDef><apiDesc> |
| 指定されたメッセージを持つ新しい NoChannelAvailableError インスタンスを作成します。 |
| |
| </apiDesc></apiConstructorDetail></apiConstructor></apiClassifier><apiClassifier id="mx.messaging.errors:MessagingError"><apiName>MessagingError</apiName><shortdesc> |
| これは、すべてのメッセージング関連エラーの基本クラスです。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseClassifier>Error</apiBaseClassifier></apiClassifierDef><apiDesc> |
| これは、すべてのメッセージング関連エラーの基本クラスです。 catch コードがそれほど詳細でなくてもかまいません。 |
| |
| </apiDesc></apiClassifierDetail><apiConstructor id="mx.messaging.errors:MessagingError:MessagingError"><apiName>MessagingError</apiName><shortdesc> |
| 指定されたメッセージを持つ新しい MessagingError インスタンスを作成します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/><apiParam><apiItemName>msg</apiItemName><apiType value="String"/><apiDesc>エラーを説明するメッセージが含まれるストリング。 |
| |
| </apiDesc></apiParam></apiConstructorDef><apiDesc> |
| 指定されたメッセージを持つ新しい MessagingError インスタンスを作成します。 |
| |
| </apiDesc></apiConstructorDetail></apiConstructor><apiOperation id="mx.messaging.errors:MessagingError:toString"><apiName>toString</apiName><shortdesc> |
| デフォルトでは、ストリング「[MessagingError]」を返します。メッセージプロパティが定義されている場合は、メッセージプロパティが含まれます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="BlazeDS" version="4"/><apiTool description="" name="LCDS" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiDesc>MessagingError のストリング表現です。 |
| |
| </apiDesc><apiType value="String"/></apiReturn></apiOperationDef><apiDesc> |
| デフォルトでは、ストリング「[MessagingError]」を返します。メッセージプロパティが定義されている場合は、メッセージプロパティが含まれます。 |
| |
| </apiDesc></apiOperationDetail></apiOperation></apiClassifier></apiPackage> |