JAVA/CORBA クラス
読み込み専用。エージェント開始時のメモリ内文書です。
定義が行われるクラスAgentContext データ型Document 構文public Document getDocumentContext() throws NotesException 使用法Lotus Notes Client のユーザーインターフェースを通してビューでアクティブにされたエージェントの場合、メモリ内文書はビューでハイライト表示されている文書です。 「新規メールの受信前」にアクティブにされたエージェントの場合、メモリ内文書は送信予定の E メールです。E メールがメールデータベースに保存される段階になるたびにエージェントがただちにアクティブにされるため、エージェントが実行されるときは常に単一の保存されていない文書を処理することになります。このエージェントタイプの場合、AgentContext の UnprocessedDocuments プロパティはまったく文書を戻しません。
OpenAgent URL コマンドによって Web ブラウザから実行されたエージェントの場合、メモリ内文書は、Lotus Domino でサポートされる CGI (コモンゲートウェイインターフェース) 変数のアイテムを含む新規の文書です。各アイテムは、サポートされる CGI 変数の名前と現在の値を保持します。(ユーザーは設計作業をする必要はありません。CGI 変数は自動的に有効になります。)
@Command([RunAgent]) または @Command[ToolsRunMacro] を使用してブラウザから実行されたエージェントの場合、メモリ内文書は現在の文書です。WebQueryOpen の場合、この文書は Lotus Domino によって HTML に変換されブラウザに送信される前の文書になります。WebQuerySave の場合、この文書は Lotus Domino によって保存される前の文書になります。文書が使用しているフォームに、Lotus Domino でサポートされる CGI 変数と同じ名前のフィールドが含まれていた場合は、メモリ内文書にはその変数の値も含まれます。(CGI 変数は、非表示フィールドのように、フォームで明示的に設計しなければなりません。)
Lotus Domino でサポートされる CGI 変数については、『アプリケーション開発者ガイド』で「CGI 変数の一覧」を参照してください。
C または C++ API を通して、外部プログラムはまずメモリ内文書を作成し、続いてエージェントを実行できます。エージェントはこのプロパティを使用して、メモリ内文書にアクセスできます。
save メソッドは、DocumentContext の返した Document オブジェクトによって表される文書を直ちに更新します。Lotus Notes Client で選択された文書に対して動作するエージェントの場合、変更内容を維持するには、終了する前に保存しておく必要があります。Web ブラウザから呼び出されたエージェントの場合は、エージェントが終了すると変更はブラウザに返されます。通常の場合は、終了前に変更内容を保存しないで、ブラウザに処理を任せます。
getDocumentContext で返された文書オブジェクトに対し、encrypt や remove メソッドは使用できません。また、getDocumentContext で返された文書オブジェクトを含むデータベースオブジェクトに対し、compact メソッドも使用できません。
クロスリファレンスLotusScript NotesSession クラスの DocumentContext プロパティ 例 関連項目