読み込み専用。エージェントが実行されたときにメモリ内にある文書です。

定義位置

AgentContext

データ型

Document

構文

public Document getDocumentContext()
   throws NotesException

使用法

Lotus Notes クライアントのユーザーインターフェースからビューでアクティブになったエージェントについては、メモリ内文書とはビューで選択されている文書になります。

「新規メールが到着する前に」アクティブ化されたエージェントの場合、メモリ内文書は、配信可能な電子メールです。各電子メールがメールデータベースに保存されようとするときに、すぐにエージェントがアクティブになるため、エージェントが実行されるたびに、ユーザーは、単一の保存されていない文書を扱うことになります。このエージェントタイプの場合、AgentContext の UnprocessedDocuments プロパティはまったく文書を戻しません。

OpenAgent URL コマンドを使用してブラウザから実行されたエージェントについては、メモリ内文書とは、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 クライアントの指定した文書に処理を行っているエージェントに対しては、更新内容が失われないように終了前に保存を行う必要があります。ブラウザで呼び出されたエージェントの場合、エージェントが終了するとすべての更新内容は反映されます。終了前に保存したくないときでも処理されます。

getDocumentContext で返された文書オブジェクトに対し、encrypt や remove メソッドは使用できません。また、getDocumentContext で返された文書オブジェクトを含むデータベースオブジェクトに対し、compact メソッドも使用できません。

クロスリファレンス

LotusScript NotesSession クラスの DocumentContext プロパティ

例
関連項目

エージェントにアクセスする

用語集