VDF を使用して開発する

このセクションでは、Vault SDK を使用している開発者や、VDF で提供されるワークフローやユーティリティを独自開発のアプリケーションで活用することを検討している開発者に役立つ情報が記載されています。

次に、VDF の構成内容の概要を示します。この概要は、クラスやメソッドに関する SDK のマニュアル(SDK インストーラを含む)全体を検索する際に役立ちます。

VDF の構成内容

VDF は SDK の新たな要素であり、旧バージョンの SDK のように Web サービス API メソッドをただ寄せ集めたものではありません。そのため、VDF の構成を理解するのは非常に重要です。現在、VDF は 4 つの DLL で構成されています(DLL 名および DLL 名で定義されている名前空間の接頭語は Autodesk.DataManagement.Client.Framework です)。次に、DLL の一覧を示します。
  • Autodesk.DataManagement.Client.Framework.dll
  • Autodesk.DataManagement.Client.Framework.Forms.dll
  • Autodesk.DataManagement.Client.Framework.Vault.dll
  • Autodesk.DataManagement.Client.Framework.Vault.Forms.dll

多くの場合、表記を簡略化するため、Autodesk...Framework の接頭語は「VDF」という文字列に置き換えられます。たとえば、キー ストロークを保存する Autodesk.DataManagement.Client.Framework.Vault という名前空間は、単純に VDF.Vault と表記されます。お気づきかもしれませんが、DLL のペアの間には類似点もあります。2 つの DLL には「Vault」が名前に含まれ、もう 2 つの DLL には「Forms」が名前に含まれています。

名前に「Vault」が含まれている DLL (およびその名前空間)には、Vault サーバに通信するための Vault 関連の通貨クラスやサービスなどの Vault の概念で使用する固有のコンポーネントがあります。名前に「Vault」が含まれていない DLL には、より一般的な目的で使用するユーティリティが用意されています。これらのユーティリティには、一般的な永続設定を管理するサービスや、ユーザへのプロンプト表示に役立つコンポーネントなどがあります。「Forms」の DLL は、WinForms のコンポーネントとワークフローで構成されます。これは、名前に「Forms」が含まれていない DLL に GUI コンポーネントがないときに、ユーザに GUI を表示する場合に多く使用されます。ほとんどの場合、VDF から提供される所定のワークフローは 2 種類に分けることができます。GUI を使用するワークフローと、GUI を使用しないワークフローです。GUI を使用するワークフローは、名前空間に「Forms」が含まれています。GUI を必要としないクライアント アプリケーションでは、VDF Forms DLL を配置する必要はありません。

VDF から提供される機能のほとんどは、2 つのエントリ ポイント(各 DLL の静的ライブラリ クラスまたは VDF 接続クラスのサービス全体)のいずれかを介してアクセスします。静的ライブラリ クラスは、各 DLL 名に一致する名前空間に配置されます。たとえば、VDF.Vault.dll には、クライアント アプリケーションで使用される静的なメソッドやサービスとともに VDF.Vault.Library クラスがあります。ライブラリ クラスは、(名前空間に「Forms」がない場合) GUI ワークフローへのアクセス、または VDF 接続が必要としないワークフローやサービスへのアクセスのほとんどを提供します。もう 1 つのエントリ ポイントである(VDF.Vault.Currency.Connection.Connection クラスの) VDF 接続オブジェクトは、接続の確立のためにクライアント アプリケーションを Vault サーバに接続する必要があります。接続オブジェクトには、Vault サーバと対話できるサービスが複数あります。たとえば、ファイルをダウンロードするための FileManager や WorkingFolder などのサービスが挙げられます。Vault 2013 SDK に習熟している方の場合、クライアントが Web サービス API を直接呼び出す必要があるときに、WebServiceManager にアクセスすることもできます。