BusinessNetworkMetadata (Common API)

Overview - Common API - Client API - Admin API - Runtime API

BusinessNetworkMetadata

Defines the metadata for a BusinessNeworkDefinition. This includes:

  • package.json
  • README.md (optional)

Applications should retrieve instances from BusinessNetworkDefinition

Details

  • Module common

Method Summary

Name Returns Description
getDescription String Returns the description for this business network
getIdentifier String Returns the identifier for this business network
getName String Returns the name for this business network
getPackageJson object Returns the package
getREADME String Returns the README
getVersion String Returns the version for this business network

Method Details

getREADME

String getREADME( )

Returns the README.md for this business network. This may be null if the business network does not have a README.md

Returns

String - the README.md file for the business network or null

Parameters

No parameters

getPackageJson

object getPackageJson( )

Returns the package.json for this business network.

Returns

object - the Javascript object for package.json

Parameters

No parameters

getName

String getName( )

Returns the name for this business network.

Returns

String - the name of the business network

Parameters

No parameters

getDescription

String getDescription( )

Returns the description for this business network.

Returns

String - the description of the business network

Parameters

No parameters

getVersion

String getVersion( )

Returns the version for this business network.

Returns

String - the description of the business network

Parameters

No parameters

getIdentifier

String getIdentifier( )

Returns the identifier for this business network. Formed from name@version.

Returns

String - the identifier of the business network

Parameters

No parameters

Inherited methods