CapyKit/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md
Jordan Wages 87bd044b31 Settings Helper + Documentation
The `SettingsHelper` is an agnostic way to access settings values uniformly through code. The accessor methods are controlled by the consumer.

Documentation has been a bit wonky. I changed the max number of version number components allowed, so each new build should not create new changes on every single bit of documentation now.
2024-04-22 18:28:21 -05:00

1.3 KiB

Subscribe Method

Subscribes the specified event handler to the event with the given subscription level and origin.

Definition

Namespace: CapyKit
Assembly: CapyKit (in CapyKit.dll) Version: 1.0.0

C#

public static void Subscribe(
	CapyEventHandler callback,
	EventLevel subscriptionLevel,
	string origin = null
)

F#

static member Subscribe : 
        callback : CapyEventHandler * 
        subscriptionLevel : EventLevel * 
        ?origin : string 
(* Defaults:
        let _origin = defaultArg origin null
*)
-> unit 

Parameters

  CapyEventHandler
The event handler to subscribe.
  EventLevel
The severity level of the event to subscribe to.
  String  (Optional)
(Optional) The name of the method or class where the subscription is made.

Remarks

If there is no existing list for the given subscription level, a new list is created and added to the dictionary.

See Also

Reference

CapyEventReporter Class
CapyKit Namespace