IPM
Definition Class Reference
Inheritance diagram for Definition:
Inheritance graph

Public Member Functions

 Display ()
 Outputs information about this server to the current device. More...
 
_.IPM.Repo.IPackageService GetPackageService ()
 Returns a client to interact with this server.
 
_.IPM.Repo.IPublishService GetPublishService ()
 Returns a client to publish modules/applications to this server. More...
 

Static Public Member Functions

_.Library.Status Configure (_.Library.Boolean pInteractive, pModifiers, pData, _.Dictionary.Classname pExpectedType)
 Called from package manager shell to create or update an instance of this class. More...
 
_.Library.Status OnConfigure (_.IPM.Repo.Definition pInstance, _.Library.Boolean pInteractive, pModifiers, pData)
 Subclasses must override. More...
 

Public Attributes

 Details
   More...
 
 Enabled
   More...
 
 Name
   More...
 
 Prereleases
   More...
 
 ReadOnly
 Boolean flag indicating that modules installed from this repository. More...
 
 Snapshots
   More...
 

Static Public Attributes

 DISPLAYNAME = None
 Display name for this type of repository, shown in the UI and package manager shell.
 
 MONIKER = None
 Short/logical name for this type of repository, used in the package manager shell as an alternative to the full class name.
 
- Static Public Attributes inherited from Commands
 CommandsAccessorIncludeFilename = None
 Name of include file that will contain accessor macros for modifiers. More...
 

Private Member Functions

_.Library.Integer __GetSortOrder ()
 Subclasses must override. More...
 

Member Function Documentation

◆ Configure()

_.Library.Status Configure ( _.Library.Boolean  pInteractive,
  pModifiers,
  pData,
_.Dictionary.Classname  pExpectedType 
)
static

Called from package manager shell to create or update an instance of this class.

Acceptable values in pModifiers and pData may vary between classes, but some (such as "name", "enabled", "snapshots", and "prereleases") are common to all. For a full list of modifiers, see the Commands XDATA block in <class>IPM.Main</class>. If specified, pExpectedType will be compared against the full classname of the existing instance matched by pModifiers("name"); an error will be returned if they do not match.

◆ Display()

Display ( )

Outputs information about this server to the current device.

Subclasses may override to show additional information, but should typically call ##super() at the beginning.

Reimplemented in Definition.

◆ GetPublishService()

_.IPM.Repo.IPublishService GetPublishService ( )

Returns a client to publish modules/applications to this server.

If publishing modules/applications is not supported, returns $$$NULLOREF. Errors are thrown as exceptions.

Reimplemented in Definition, and Definition.

◆ __GetSortOrder()

_.Library.Integer __GetSortOrder ( )
private

Subclasses must override.

Orders repositories by type and possibly other factors.

Reimplemented in Definition, and Definition.

◆ OnConfigure()

_.Library.Status OnConfigure ( _.IPM.Repo.Definition  pInstance,
_.Library.Boolean  pInteractive,
  pModifiers,
  pData 
)
static

Subclasses must override.

Allows handling of any custom modifiers/data attributes provided from the package manager shell.

Member Data Documentation

◆ Details

Details

 

 

◆ Enabled

Enabled

 

 

◆ Name

Name

 

 

◆ Prereleases

Prereleases

 

 

◆ ReadOnly

ReadOnly

Boolean flag indicating that modules installed from this repository.

are ALWAYS installed in non-developer mode.  

◆ Snapshots

Snapshots