GETGATEWAYHELPER |
説明 ColdFusion イベントゲートウェイに使用するためのメソッドとプロパティを提供する Java GatewayHelper オブジェクトを取得します。
戻り値 Java GatewayHelper オブジェクトです。
カテゴリ 拡張可能関数
関数のシンタックス
    GetGatewayHelper(gatewayID)
関連項目 SendGatewayMessage
ヒストリ ColdFusion MX 7: この関数が追加されました。
パラメータ
使用方法 ColdFusion GetGatewayHelper 関数は、イベントゲートウェイ固有のヘルパのメソッドおよびプロパティを提供する Java GatewayHelper オブジェクトを返します。この関数を使用するには、イベントゲートウェイにより、GatewayHelper クラスを実装するクラスへのアクセスが可能になる必要があります。たとえば、インスタントメッセージングイベントゲートウェイにより、バディリスト管理関数を GatewayHelper オブジェクトで使用できるようにすることができます。 イベントゲートウェイリスナ CFC は、着信メッセージの CFEvent 構造体から gatewayID の値を取得することができます。 標準の ColdFusion Java オブジェクトアクセステクニックを使用して、GatewayHelper オブジェクトのメソッドおよびプロパティにアクセスします。詳細については、『ColdFusion MX 開発ガイド』の第42章の「イベントゲートウェイの使用」 の「GatewayHelper オブジェクトの役割」を参照してください。
例 イベントゲートウェイのヘルパクラスに、単一の String パラメータをとる addBuddy メソッドが含まれている場合、次のコードを使用して、GatewayHelper オブジェクトを取得し、バディをバディリストに追加することができます。
    <h3>GetGatewayHelper の例</h3>
    <cfscript>
       myHelper = getGatewayHelper(myGatewayID);
       status = myHelper.addBuddy(ﾒjsmithﾓ);
    </cfscript>

GATEWAYID |
GatewayHelper オブジェクトを提供するゲートウェイの識別子です。ColdFusion MX Administrator の [イベントゲートウェイ] セクションの [Gateways] ページで設定された、いず れかの ColdFusion イベントゲートウェイインスタンスのゲートウェイ ID でなければなりません。