FirstClassオブジェクトについて
サーバに存在するアイテムはすべてFirstClassオブジェクトです。テンプレートは、FirstClassオブジェクトを表示するために使用します。Webテンプレートをカスタマイズするには、複数のレベルのオブジェクトおよびそのオブジェクトを表示するテンプレートの作成方法について理解する必要があります。オブジェクトは、以下の3つに分類されます。
・フォームオブジェクト
・一覧オブジェクト
・例外
フォームオブジェクト
フォームオブジェクトとは、サーバに存在し、データを含んでいるフォームのことです。フォームオブジェクトには以下のものがあります。
・メールフォーム(読み取り専用バージョンと編集可能バージョン)
・ドキュメント(読み取り専用バージョンと編集可能バージョン)
・memフォーム(編集のみ)
・システムフォーム(読み取り専用バージョンと編集可能バージョン)
・カレンダーフォーム(読み取り専用)
メールフォーム(読み取り専用バージョンと編集可能バージョン)
メールフォームはサーバに存在し、データを含んでいますが、特に送信操作をサポートします。メールフォームには以下のものがあります。
・[メッセージ]
・[電話メモ]フォーム
・[ファイルの転送]フォーム
ドキュメント(読み取り専用バージョンと編集可能バージョン)
ドキュメントとは、サーバに保存されるが送信されないアイテムです(送信操作をサポートしていません)。
Memフォーム(編集のみ)
memフォームは仮想フォームで、サーバに存在するオブジェクトではありませんが、サーバに存在するように動作します。memフォームはドキュメントに似ており、保存されますが、送信されません。このフォームは動作に関係しており、以下のものがあります。
・[自動登録]フォーム
・[パスワードの変更]フォーム
システムフォーム(読み取り専用バージョンと編集可能バージョン)
システムフォームはFirstClassによって使用され、サーバに存在しますが、これを作成したり、削除することはできません。システムフォームには以下のものがあります。
・[基本設定]
・[システムプロファイル]フォーム
カレンダーフォーム(読み取り専用)
カレンダーは一覧としてではなく、月または週ごとに表示されるときにフォームと見なされます。
一覧オブジェクト
一覧オブジェクトは、一覧で表示されます(メ―ルボックスのメッセージ一覧や会議室のドキュメント一覧など)。どの一覧も複数のテンプレートから構成され、ゼロ未満のIDを持ちます。
一覧オブジェクトは以下から構成されます。
・検索一覧
・ディレクトリ一覧
・在席確認一覧
・履歴一覧
コンテナ一覧およびリーフオブジェクト
コンテナは、他のサブコンテナとリーフオブジェクトの一覧を保持し、それを表示します。リーフオブジェクトは、コンテナ以外のアイテムであり、FirstClassクライアントの分割表示で別のペインに一覧表示されます。
以下に、コンテナオブジェクトの例を示します。
・会議室
・フォルダ
・カレンダー
以下に、リーフオブジェクトの例を示します。
・メッセージ
・ドキュメント
・ブックマーク
・予定
・作業
・アップロードファイル
コンテナ一覧のフィルタリング
コンテナオブジェクトおよびリーフオブジェクトの一覧の出力は、特定の範囲に制限することができます(通常、ダウンロード時間を短縮する「ページ区切り」を導入するために使用します)。コンテナオブジェクトおよびリーフオブジェクトの範囲はそれぞれ異なります。この範囲は、nItems、nFolders、FirstItem、FirstFolder、LastItem、およびLastFolderを使用することによってURLパラメータレベルで、または複数のコンテナ一覧のタグを使用することによってテンプレート内部で制御することができます。コンテナ一覧で削除されたアイテムを参照する場合は、「Show deleted」URLパラメータを使用してください(例:"<X-FC-OBJURL>?Showdeleted = 1")。
2つ以上のタグまたはアイテムを使用する場合、3番目のタグまたはアイテムは無視されます。インターネットサービスでは、オブジェクトURLとテンプレートコードのいずれかで、最初の2つのタグまたはアイテムだけが読み取られます。
コンテナ一覧の並べ替えおよびグループ化
並べ替えとグループ化によって、URLパラメータで指定した基準で一覧が並べ替えられます。デフォルトでは、ユーザの並べ替えパラメータは、クライアントの並べ替えパラメータセットに従います。並べ替えとグループ化の動作を変更する場合は、URLパラメータを使用します。URLパラメータの構文は、以下のとおりです。
[I|F]table[commit]=SortCol[_GroupCol]
このうち、
・SortColは、列の並べ替えを変更します。
・GroupColは、列のグループ化を変更します。
SortColもGroupColもパラメータは、([-] ColID +1)です。(ColID + 1)は、評価される数式です。SortColが0より小さい場合、これは逆順の並べ替えを意味します。GroupColが0より小さい場合、これはグループを折りたたむことを意味します。
このうち、
・[commit]は、新しい並べ替えまたはグループの列をサーバに保存します(変更内容をコミットします)。
・[I|F]は、アイテムまたはフォルダを並べ替えます([I]リテラル項を使用する前にビューに分割があることを確認してください)。
現在有効な列の一覧については、「X-FC-LAYOUT」タグを参照してください。
コンテナデフォルト一覧モード
コンテナオブジェクトのデフォルト一覧は、複数のテンプレートの組み合わせです。デフォルト一覧は5つのセクションに分割され、以下の順序に従います。
1 「ヘッダ」テンプレート(-1および-10)
2. 「サブコンテナ」一覧のテンプレート(-11、-12、-14)
3 「区切り」テンプレート(-15)
4 「コンテナ以外のオブシェクト」一覧のテンプレート(-16から-18)
5 「フッタ」テンプレート(-2)
一部のコンテナの内容が必要でない場合、必要な最後のテンプレートに<X-FC-HEADER-ONLY>タグを追加することによってどの時点でも処理を中止できます。
コンテナ構成要素一覧モード
インターネットサービスには、一覧に含まれるオブジェクトのタイプに基づいて一覧をフィルタリングする機能が用意されています(サブコンテナや一覧など)。コンテナのURLにパラメータを追加することによってこの一覧を取得することができます。以下に、必要な複数のURLパラメータについて説明します。
・サブコンテナだけをフィルタリングする場合は、「Folders」URLパラメータを使用します。
・リーフオブジェクトアイテムだけをフィルタリングする場合は、「Items」URLパラメータを使用します。
・両方を結合した一覧の場合は、両方のパラメータを使用します。
すべてのパラメータが、「-205」、「-206」、および「-207」テンプレートを使用します。
以下に、3つのケースすべてに当てはまる例を記載します。
[<X-FC-OBJURL>?Folders = 1-10]
このURLは、コンテナ内にある最初の10個のサブコンテナを一覧表示します。
フィルタリングの引数は、構文filter=first-lastを使用するとページ区切り引数として使用することも可能です。詳細については、このドキュメント内のフィルタのセクションを参照してください。
検索一覧
[検索]フォームは、FirstClassで検索フィルタの基準を指定できるシステムフォームです。このシステムフォームのフォームIDは、8000です。検索を実行すると(8000システムフォームを使用)、結果は以下のテンプレートを使用して表示されます。
・-300(検索一覧のヘッダ)
・-301(検索一覧のアイテム)
・-302(検索一覧のアイテム進捗)
このテンプレートは、変更された検索フォルダを表示します。
・-303(検索一覧のフッタ)
ディレクトリ一覧
FirstClassディレクトリとは、メールの宛先となる、システム内のすべてのものの一覧です(ユーザ、会議室、コンタクト、エイリアスなど)。ディレクトリ一覧は、以下から構成されます。
・ディレクトリフィルタ
・ディレクトリ検索一覧
・名前検証
・在席確認
ディレクトリフィルタ
ディレクトリフィルタパラメータは、ディレクトリの一部だけを表示するために使用します。ディレクトリには通常多数のアイテムがあるため、ユーザがその一部だけを表示する場合に役立ちます。
検索を実行すると、種類または名前に基づいてフィルタリングされます。種類に基づくフィルタリングの場合は、以下のディレクトリエントリをフィルタリングすることができます。
・ローカル名(ローカルシステムのユーザとすべての登録アドレス)
・リモート名(ゲートウェイシステム上のユーザ)
・会議室(ユーザがディレクトリ一覧で閲覧可能なすべての会議室)
・コンタクト(すべての登録アドレス)
・インターネットエイリアス(すべてのインターネットアドレスエイリアス)
上記のフィルタはすべて整数で、URLパラメータで「オン」に1を使用し、「オフ」に0を使用します。デフォルトフィルタは、local/remote/conferenceです。
名前に基づくフィルタリングの場合、名前全体または名前の一部で検索することができます。どちらの場合も、srchパラメータを使用します。また、ブラウザを使用している場合、charsetパラメータを、お使いのシステムの正しい文字セット(ISO文字セットコード)に設定することをお勧めします。
ディレクトリ検索一覧
簡単なディレクトリ一覧を開く場合(ユーザにメールを送信する、ユーザカレンダーを開く、またはプロフィールを開く場合など)、<X-FC-LOGIN>Directory URLを使用します。この種類の一覧に使用するテンプレートは次のとおりです。
・100(ディレクトリフォーム)
・104(ディレクトリフォームフッタ)
ディレクトリ参照を実行する場合は、ディレクトリ検索一覧のURL
<X-FC-LOGIN>Directory/Lookupを使用します。この種類の一覧に使用するテンプレートは次のとおりです。
・-100(ディレクトリフォーム)
・-101(ディレクトリ一覧のヘッダ)
・-102(複数の結果には複数の「-102」テンプレートが必要)または-105(結果なし)
・-103(ディレクトリ一覧のフッタ)
名前検証
フィールドの名前を検証するには、<X-FC-OBJURL SLASH>Lookup URLを使用します。<X-FC-OBJURL >は、どのようなオブジェクトの名前を検証していても含まれます(名前の検証後、サーバによってここに名前が追加されます)。
備品カレンダーまたは場所カレンダーなどの一部のオブジェクトには、ディレクトリ一覧に制限があり、フィルタが使用されます。この種類の一覧に使用するテンプレートは次のとおりです。
・-100(ディレクトリフォーム)
・-101(ディレクトリ一覧のヘッダ)
・-102(名前要求ごとに1つ)
・-105(名前要求が存在する場合のみ)
・-103(ディレクトリ一覧のフッタ)
名前検証では、以下の追加パラメータをサポートしている場合や、以下のパラメータを必要とする場合があります。
・Operation
・Insert|Insert Multi
このパラメータを使用して、受信者一覧に挿入する受信者を検索します。Insert|Insert Multiパラメータでは、以下のパラメータを使用します。
・ Field ID = fieldid
これは、挿入するフィールドを指定する必須パラメータです。
・[Index = index]
このパラメータによって、受信者名を挿入する一覧内の場所を指定します。
・[standard Directory parameters]
このパラメータは、ディレクトリのフィルタリングに使用する標準ディレクトリパラメータです(ディレクトリ一覧のタグを参照)。
一致する単一の受信者をInsertパラメータが返した場合、その受信者名はサーバのオブジェクトに直接挿入されます。たとえば、メッセージを開いて、完全に一致する名前を[宛先]フィールドに入力した場合、その名前はそのフィールドの一覧に自動的に追加されます。ディレクトリ一覧は必要ありません。Insert MultiパラメータはInsertパラメータと同じ構文を使用しますが、サーバのオブジェクトに複数の名前を挿入します。
・Delete
Deleteパラメータを使用して、受信者一覧から名前を削除します。パラメータの有効な値は以下のとおりです。
・Field ID = fieldid
このパラメータによって、削除元のフィールドを指定します。
・[Index = index]|[client ID = clientid]
このパラメータには、一覧内の位置によって名前を削除するindexパラメータ(1度に1つ)か、1つ以上のclient IDパラメータ(クライアントIDの最初のインスタンスを削除)を入れる必要があります。
Indexパラメータの例
[宛先]一覧にname1、name2、name3があり、このURLによってname1を削除する場合の例を示します。
<X-FC-OBJURL SLASH>Lookup?Operation=Deleted&FieldID=9&Index=0>
・Add
Addパラメータを使用して、受信者一覧から名前を追加します。パラメータの有効な値は以下のとおりです。
・Field ID = fieldid
このパラメータによって、追加先のフィールドを指定します。
・[Index = index]
このパラメータによって、新しい名前を配置する一覧内の場所を指定します。
・Client ID = clientid
このパラメータには、1つ以上のクライアントIDが必要です。インデックスを指定した場合、クライアントIDは逆順で追加されます。インデックスを指定しない場合、順序は設定されません。
在席確認一覧
在席確認一覧は、現在ログインしているユーザのうち表示が許可されているすべてのユーザの一覧です。在席確認一覧を開くには、URL「<X-FC-LOGIN>whosonline」を使用します。この一覧に使用するテンプレートは以下のとおりです。
・-400(在席確認のヘッダ)
・-401(在席確認のアイテム)
・-402(在席確認のフッタ)
履歴一覧
履歴一覧は、リーフオブジェクト(カレンダーの予定、メッセージ、ドキュメントなど)の履歴を表示します。履歴一覧を開くには、URL「<X-FC-OBJURL SLASH>history」を使用します。
使用するテンプレートは以下のとおりです。
・-110(履歴ヘッダ)
・-111(履歴アイテム)
・-112(履歴一覧のフッタ)
例外
例外は、オブジェクトでも一覧でもないものです。例外には、ステーショナリ、インスタントメッセージ、モニタなどがあります。ただし、フィルタリングされたコンテナ一覧では、この例外は、サブコンテナ内に表示
されます。インターネットサービスでは、本来このようなオブジェクトをWebに表示しません。
| ||