Difference between revisions of "INotificationEvents"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the INotificationEvents class)
(Documentation for the INotificationEvents class)
Line 1: Line 1:
 +
This interface describes a Layer Two extensibility point. Components can implement this interface and an instance of the implementing class will be created by MEF on startup.
 +
Notification events form a powerful component communication infrastructure, and offer notifications about settings changes.
 +
 +
'''See also:''' [[NotificationEventsHandler]]
 +
 
===Remarks <nowiki>[</nowiki>[{{fullurl:INotificationEvents Remarks|action=edit}} edit]<nowiki>]</nowiki>===
 
===Remarks <nowiki>[</nowiki>[{{fullurl:INotificationEvents Remarks|action=edit}} edit]<nowiki>]</nowiki>===
 
{{:INotificationEvents Remarks}}
 
{{:INotificationEvents Remarks}}
Line 4: Line 9:
 
===Methods===
 
===Methods===
 
:{{CSharp|void ChangeNotify(string selector, Guid? id)}}
 
:{{CSharp|void ChangeNotify(string selector, Guid? id)}}
 +
::
 +
::A notification of a change submitted by your own component through LayerOne.ComponentSystem.ChangeNotify. This event only fires on the instance host.
  
 
:{{CSharp|void EntityEvent(IConnectionIdentity identity, string identifier, Guid? context, Decimal? amount)}}
 
:{{CSharp|void EntityEvent(IConnectionIdentity identity, string identifier, Guid? context, Decimal? amount)}}
 +
::
 +
::Fires for each connection belonging to the entity passed in to EntitySystem.FireEntityEvent (or the provided connection)
  
 
:{{CSharp|IEnumerable<TagHint> GetTagHints()}}
 
:{{CSharp|IEnumerable<TagHint> GetTagHints()}}
 +
::
 +
::L1 request for tag hints
  
 
:{{CSharp|void ProviderChangeNotify(string selector, Guid? id)}}
 
:{{CSharp|void ProviderChangeNotify(string selector, Guid? id)}}
 +
::
 +
::A notification of a change submitted by your own component through LayerOne.ComponentSystem.ChangeNotify. This event only fires on the service provider.
  
 
:{{CSharp|void ProviderEntityEvent(Guid entityID, string identifier, Guid? context, Decimal? amount)}}
 
:{{CSharp|void ProviderEntityEvent(Guid entityID, string identifier, Guid? context, Decimal? amount)}}
 +
::
 +
::Fires once on the service provider for each entity event, regardless of whether any connection is online belonging to this entity
  
 
:{{CSharp|void ProviderSettingChange()}}
 
:{{CSharp|void ProviderSettingChange()}}
 +
::
 +
::Fires on the service provider when a change is made to a system setting
  
 
:{{CSharp|void ProviderSystemEvent(string identifier, Guid? context, Decimal? amount)}}
 
:{{CSharp|void ProviderSystemEvent(string identifier, Guid? context, Decimal? amount)}}
 +
::
 +
::Fires once on the service provider for each system event
  
 
:{{CSharp|void ReceiveOnChannel(string channelName, JObject message)}}
 
:{{CSharp|void ReceiveOnChannel(string channelName, JObject message)}}
 +
::
 +
::Fires on each subscriber (SP or IH) when a component channel message is received
  
 
:{{CSharp|void SettingChange()}}
 
:{{CSharp|void SettingChange()}}
 +
::
 +
::Fires on the instance host when a change is made to a system setting
  
 
__NOTOC____NOEDITSECTION__
 
__NOTOC____NOEDITSECTION__

Revision as of 16:34, 21 October 2016

This interface describes a Layer Two extensibility point. Components can implement this interface and an instance of the implementing class will be created by MEF on startup. Notification events form a powerful component communication infrastructure, and offer notifications about settings changes.

See also: NotificationEventsHandler

Remarks [edit]

Methods

void ChangeNotify(string selector, Guid? id)
A notification of a change submitted by your own component through LayerOne.ComponentSystem.ChangeNotify. This event only fires on the instance host.
void EntityEvent(IConnectionIdentity identity, string identifier, Guid? context, Decimal? amount)
Fires for each connection belonging to the entity passed in to EntitySystem.FireEntityEvent (or the provided connection)
IEnumerable<TagHint> GetTagHints()
L1 request for tag hints
void ProviderChangeNotify(string selector, Guid? id)
A notification of a change submitted by your own component through LayerOne.ComponentSystem.ChangeNotify. This event only fires on the service provider.
void ProviderEntityEvent(Guid entityID, string identifier, Guid? context, Decimal? amount)
Fires once on the service provider for each entity event, regardless of whether any connection is online belonging to this entity
void ProviderSettingChange()
Fires on the service provider when a change is made to a system setting
void ProviderSystemEvent(string identifier, Guid? context, Decimal? amount)
Fires once on the service provider for each system event
void ReceiveOnChannel(string channelName, JObject message)
Fires on each subscriber (SP or IH) when a component channel message is received
void SettingChange()
Fires on the instance host when a change is made to a system setting