ISBPIIntegrationPluginインターフェース

<< 目次を表示 >>

ページ位置:  プロジェクトの作成と管理 > Proクラウドサーバ > 有料ライセンスで利用できる機能 > 外部ツールとの連携 > 独自の連携プラグインの作成 >

ISBPIIntegrationPluginインターフェース

ISBPIIntegrationPluginインターフェースでは、以下のメソッドが定義されています。

 

 

ISBPIIntegrationPlugin インターフェースのメソッド

ほとんどのメソッドでは、文字列型のパラメータ(引数)を1つのみ持ちます。JSON形式で詳細な情報を渡します。

 

メソッド名

説明

CreateWebEAHyperlink

連携要素に対するWebEAのリンクを作成します。

GenericRequest

将来の拡張のためのメソッドです。利用されていません。

GetAuthorisationDetails

連携ツールプロバイダが必要とする認証方法を返します。サポートされている種類は、none・basic・OAuthです。

GetDefaultFieldMapping

外部項目のフィールドやプロパティが、Enterprise Architectの要素のプロパティやタグ付き値にどのように対応しているかの一覧を返します。

GetDefaultTypeMapping

外部項目の型とEnterprise Architectの要素の型との対応関係の一覧を返します。

GetFields

連携ツールプロバイダの既知のフィールド・プロパティの一覧を返します。

GetIcon

連携ツールプロバイダのアイコンを返します。

GetItem

選択された項目の完全なプロパティを返します。

GetItemDiscussion

選択した外部アイテムに関するコメントやディスカッションを、ディスカッションサブウィンドウの連携ツールタブに表示します。

GetItemList

連携ツールウィンドウの、指定されたメニューレベルの項目リストを返します。

GetItemNotes

選択された外部項目の詳細をノートサブウィンドウの連携ツールタブに表示します。

GetItems

選択された項目の完全なプロパティを返します。

GetMenuList

連携ツールウィンドウの指定されたメニューレベルのメニュー項目を返します。

GetTypes

連携ツールプロバイダの既知の種類の一覧を返します。

ItemLinked

外部項目がEnterprise Architectの要素にリンクされていることを通知します。

(ビルド1559以降で利用可能)

ItemUnlinked

外部の項目がEnterprise Architectの要素からリンクされていないことを通知します。

(ビルド1559以降で利用可能)

ItemUpdated

Enterprise Architectのリンク先の要素が更新・変更されたことを通知します。

(ビルド1559以降で利用可能)

PostNewDiscussion

外部項目に新しいコメントやディスカッションを追加します。

PostNewItem

連携ツールプロバイダに新しい項目を作成します。

PostOAuthCode

コードをOAuthアクセストークンと交換するためのアクセストークンリクエストを行います。AddPropertyでaccessTokenとrefreshTokenを返します。

PostUpdateItem

選択された項目を連携ツールプロバイダ側で更新します。

PostUpdatedItemNotes

選択された項目のノートを連携ツールプロバイダ側で更新します。

(ビルド1559以降で利用可能)

RefreshOAuthToken

OAuthリフレッシュエンドポイントに対してリフレッシュリクエストを実行し、新しいaccessTokenとrefreshTokenを返します。

Release

C++のみ。インターフェースのクラスが不要になった場合に呼び出されます。内部に保持する変数などを解放してください。

SetAuthorisation

Enterprise Architect内でユーザーが入力した認証情報を取得します。

SetCallbacks

(const void ** callbackFunctions)

C++のみ。コールバック関数を渡します。

SetConfiguration

Proクラウドサーバの外部ツール連携における設定情報を取得します。