Difference between revisions of "ProviderLifetimeEventsHandler"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the ProviderLifetimeEventsHandler class)
 
(Documentation for the ProviderLifetimeEventsHandler class)
Line 1: Line 1:
This class implements a Layer Two extensibility point as virtual members which can be overriden as needed. Derive from this class to provide your own implementation.
 
 
'''See also:''' [[IProviderLifetimeEvents]]
 
 
'''See also:''' [[IComponentEvents]]
 
 
 
===Remarks <nowiki>[</nowiki>[{{fullurl:ProviderLifetimeEventsHandler Remarks|action=edit}} edit]<nowiki>]</nowiki>===
 
===Remarks <nowiki>[</nowiki>[{{fullurl:ProviderLifetimeEventsHandler Remarks|action=edit}} edit]<nowiki>]</nowiki>===
 
{{:ProviderLifetimeEventsHandler Remarks}}
 
{{:ProviderLifetimeEventsHandler Remarks}}
Line 10: Line 4:
 
===Methods===
 
===Methods===
 
:{{CSharp|void AttachComponent(Guid rootWorldID)}}
 
:{{CSharp|void AttachComponent(Guid rootWorldID)}}
::
 
::Called when your component is installed on a root world
 
  
 
:{{CSharp|void ComponentAttached(Guid componentID, Guid rootWorldID)}}
 
:{{CSharp|void ComponentAttached(Guid componentID, Guid rootWorldID)}}
::
 
::Called after a component is installed on a root world to notify other components of this fact
 
  
 
:{{CSharp|void ComponentDetaching(Guid componentID, Guid rootWorldID)}}
 
:{{CSharp|void ComponentDetaching(Guid componentID, Guid rootWorldID)}}
::
 
::Called before a component is unsinstalled from a root world to notify other components of this fact
 
  
 
:{{CSharp|void DetachComponent(Guid rootWorldID)}}
 
:{{CSharp|void DetachComponent(Guid rootWorldID)}}
::
 
::Called when your component is uninstalled from a root world
 
  
 
:{{CSharp|void Initialize()}}
 
:{{CSharp|void Initialize()}}
::
 
::Fires when the service provider service starts up and initializes the Layer Two component system
 
  
 
:{{CSharp|bool Install()}}
 
:{{CSharp|bool Install()}}
::
 
::Called once by the service provider on component install
 
  
 
:{{CSharp|Byte[] PackSeedData(ITransferItem item)}}
 
:{{CSharp|Byte[] PackSeedData(ITransferItem item)}}
::
 
::Asks the component to package any seed data that should be delivered along with a component install or upgrade. Try to keep this less than a few MB if possible!
 
  
 
:{{CSharp|void Shutdown()}}
 
:{{CSharp|void Shutdown()}}
::
 
::Fires when the service provider service is shutting down
 
  
 
:{{CSharp|void SystemIntegrityCheckCompleted()}}
 
:{{CSharp|void SystemIntegrityCheckCompleted()}}
::
 
::Called by L1 after a system-wide layout validation and integrity check
 
  
 
:{{CSharp|void SystemIntegrityCheckStarting()}}
 
:{{CSharp|void SystemIntegrityCheckStarting()}}
::
 
::Called by L1 before a system-wide layout validation and integrity check
 
  
 
:{{CSharp|bool Uninstall()}}
 
:{{CSharp|bool Uninstall()}}
::
 
::Called once by the service provider on component uninstall
 
  
 
:{{CSharp|void UnPackSeedData(Byte[] data)}}
 
:{{CSharp|void UnPackSeedData(Byte[] data)}}
::
 
::Asks the component to import seed data provided as part of an update or install. This will be the first method called on a component even before Install or Initialize
 
  
 
:{{CSharp|bool Upgrade()}}
 
:{{CSharp|bool Upgrade()}}
::
 
::Called by the service provider when this component is being upgraded from a previous version
 
  
 
__NOTOC____NOEDITSECTION__
 
__NOTOC____NOEDITSECTION__

Revision as of 17:40, 20 October 2016

Remarks [edit]

Methods

void AttachComponent(Guid rootWorldID)
void ComponentAttached(Guid componentID, Guid rootWorldID)
void ComponentDetaching(Guid componentID, Guid rootWorldID)
void DetachComponent(Guid rootWorldID)
void Initialize()
bool Install()
Byte[] PackSeedData(ITransferItem item)
void Shutdown()
void SystemIntegrityCheckCompleted()
void SystemIntegrityCheckStarting()
bool Uninstall()
void UnPackSeedData(Byte[] data)
bool Upgrade()