Prev Next

ISBPIIntegrationPlugin interface

The ISBPIIntegrationPlugin interface provides a range of methods.

ISBPIIntegrationPlugin Interface Methods

Most methods have a single string parameter (char* in C++, string in C#) that is encoded as JSON to provide a variety of parameters.

The ISBPIIntegrationPlugin interface provides these methods:

Method Name

Notes

See also

CreateWebEAHyperlink

Adds a link to WebEA within the External Item.

CreateWebEAHyperlink

GenericRequest

Reserved for future use.

GetAuthorisationDetails

Returns the Authorization methods that your provider requires. Supported types are: none, basic and OAuth.

GetAuthorisationDetails

GetDefaultFieldMapping

Returns a list of how the External Item fields and properties map to the Enterprise Architect element fields, properties and Tagged Values.

GetDefaultFieldMapping

GetDefaultTypeMapping

Returns a list of how the External Item types map to the Enterprise Architect element types.

GetDefaultTypeMapping

GetFields

Returns a list of known fields/properties in the External Provider.

GetFields

GetIcon

Returns an icon for the External Provider.

GetIcon

GetItem

Returns the full properties for the selected item.

GetItem

GetItemDiscussion

Populates the 'External' tab in the main Discussion window with comments and discussions on the selected external item.

GetItemDiscussion

GetItemList

On receipt of a request to populate the list of items in the External Data window for the selected menu level, this method fills in the items.

GetItemList

GetItemNotes

Populates the 'External' tab in the main Notes window with details of the selected external item.

GetItemNotes

GetItems

Returns the full properties for the selected items.

GetItems

GetMenuList

On receipt of a request to populate the menu in the External Data window, this method fills in the menu items.

GetMenuList

GetTypes

Returns a list of known types in the External Provider.

GetTypes

ItemLinked

(Requires Enterprise Architect Release 15.2 build 1559 and above.)

Notification that an external item has been linked to an element in Enterprise Architect.

ItemLinked

ItemUnlinked

(Requires Enterprise Architect Release 15.2 build 1559 and above.)

Notification that an external item has been unlinked from an element in Enterprise Architect.

ItemUnlinked

ItemUpdated

(Requires Enterprise Architect Release 15.2 build 1559 and above.)

Notification that a linked element in Enterprise Architect has been updated or modified.

ItemUpdated

PostNewDiscussion

Adds a new comment or discussion to the External Item.

PostNewDiscussion

PostNewItem

Creates a new item in the External Provider.

PostNewItem

PostOAuthCode

Makes an Access Token Request to exchange the code for an OAuth Access Token (using the OAuth token endpoint). Returns the accessToken and refreshToken with AddProperty.

PostOAuthCode

PostUpdateItem

Updates the selected item in the External Provider.

PostUpdateItem

PostUpdateItemNotes

Updates the notes of the selected item in the External Provider.

PostUpdateItemNotes

RefreshOAuthToken

Performs a refresh request against the OAuth refresh endpoint and returns the new accessToken and refreshToken.

RefreshOAuthToken

Release

C++ only. This method is called by the controlling application when the interface Class is no longer required. The method deletes the Class created during the CreatePlugin() function.

SetAuthorisation

Receives authorization information that the user enters within Enterprise Architect.

SetAuthorisation

SetCallbacks(const void ** callbackFunctions)

C++ only. Passes in an array of callback function pointers that are used by the Plug-in later on to pass data back to Enterprise Architect.

SetCallbacks

SetConfiguration

Receives the settings defined when the user sets up the Custom Integration Plug-in in Pro Cloud Server.

SetConfiguration