名前 | 解説 | |
---|---|---|
DocumentStatus コンストラクタ |
DocumentStatusデータ型で公開されるメンバを以下の表に示します。
名前 | 解説 | |
---|---|---|
changedPages | 前回の GetDocumentStatus の呼び出し以降に変更された ページのインデックス(呼び出しは Cookie フィールドで追跡されます)。 | |
cookie | C1Report サービスによって生成された Cookie データ。 | |
created | 作成日。 | |
documentKey | キャッシュされたドキュメントを識別する一意のキー。 | |
error | サーバーにエラーが発生した場合はエラーの説明が含まれます。 通常は null です。 | |
exportFormats | 現在のドキュメントに使用できるエクスポート形式。 リストは、エクスポート形式の説明/その拡張子のデフォルト拡張子の一連のペアです。
説明はリスト内で形式を一意に識別できる必要があります。 拡張子は小文字でドット(.)は含めません(例:"pdf")。 ドキュメントが生成中でない場合(isGenerating が | |
h | ズーム 100%、96 dpi の場合のピクセル単位のデフォルトページ幅 | |
isGenerating | 現在のレポートが生成中で、レポート情報を取得できないことを示します。 | |
name | レポート名。 | |
pageCount | 総ページ数。 | |
pageSizes | 同サイズのページの間隔の配列。 間隔はページインデックスによってソートでき、 0〜pageCount のすべてのページをカバーすることが保証されています。 | |
percentComplete | レポートが生成中の場合、0〜100 の作業完了度のおおよその割合を取得します。 | |
reportParams | 必須レポートパラメータの配列。要素はサーバーによって満たされます。 null の場合もありますが、サーバーから非 null の値が返された場合、 クライアントがドキュメントを生成するときに、 この情報を使用してパラメータ名/パラメータ値リストを満たし、サーバーに渡す必要があります。 | |
state | 現在のレポートは生成中の状態(準備完了、ページの追加中、ページの更新中)にあります。 | |
type | ビュータイプ(ページ画像または HTML)。 | |
w | ズーム 100%、96 dpi の場合のピクセル単位のデフォルトページ幅 |