### YamlMime:ManagedReference items: - uid: CapyKit.CapyEventReporter commentId: T:CapyKit.CapyEventReporter id: CapyEventReporter parent: CapyKit children: - CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[]) - CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[]) - CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String) - CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler,System.String) langs: - csharp - vb name: CapyEventReporter nameWithType: CapyEventReporter fullName: CapyKit.CapyEventReporter type: Class source: remote: path: CapyKit/CapyEvent.cs branch: main repo: https://git.jordanwages.com/wagesj45/CapyKit.git id: CapyEventReporter path: ../CapyKit/CapyEvent.cs startLine: 19 assemblies: - CapyKit namespace: CapyKit summary: The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit. remarks: >- Because consumers of CapyKit may have varied ways of handling logging, the provides a way for subscribers to recieve events for various "events" within the library. These can be thought of as a logging solution for CapyKit. Consumers are free to treat these events however they see fit. example: [] syntax: content: public static class CapyEventReporter content.vb: Public Module CapyEventReporter inheritance: - System.Object inheritedMembers: - System.Object.Equals(System.Object) - System.Object.Equals(System.Object,System.Object) - System.Object.GetHashCode - System.Object.GetType - System.Object.MemberwiseClone - System.Object.ReferenceEquals(System.Object,System.Object) - System.Object.ToString - uid: CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String) commentId: M:CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String) id: Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String) parent: CapyKit.CapyEventReporter langs: - csharp - vb name: Subscribe(CapyEventHandler, EventLevel, string) nameWithType: CapyEventReporter.Subscribe(CapyEventHandler, EventLevel, string) fullName: CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler, CapyKit.EventLevel, string) type: Method source: remote: path: CapyKit/CapyEvent.cs branch: main repo: https://git.jordanwages.com/wagesj45/CapyKit.git id: Subscribe path: ../CapyKit/CapyEvent.cs startLine: 49 assemblies: - CapyKit namespace: CapyKit summary: >- Subscribes the specified event handler to the event with the given subscription level and origin. remarks: >- If there is no existing list for the given subscription level, a new list is created and added to the dictionary. example: [] syntax: content: public static void Subscribe(CapyEventHandler callback, EventLevel subscriptionLevel, string origin = null) parameters: - id: callback type: CapyKit.CapyEventHandler description: The event handler to subscribe. - id: subscriptionLevel type: CapyKit.EventLevel description: The severity level of the event to subscribe to. - id: origin type: System.String description: (Optional) The name of the method or class where the subscription is made. content.vb: Public Shared Sub Subscribe(callback As CapyEventHandler, subscriptionLevel As EventLevel, origin As String = Nothing) overload: CapyKit.CapyEventReporter.Subscribe* nameWithType.vb: CapyEventReporter.Subscribe(CapyEventHandler, EventLevel, String) fullName.vb: CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler, CapyKit.EventLevel, String) name.vb: Subscribe(CapyEventHandler, EventLevel, String) - uid: CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler,System.String) commentId: M:CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler,System.String) id: Unsubscribe(CapyKit.CapyEventHandler,System.String) parent: CapyKit.CapyEventReporter langs: - csharp - vb name: Unsubscribe(CapyEventHandler, string) nameWithType: CapyEventReporter.Unsubscribe(CapyEventHandler, string) fullName: CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler, string) type: Method source: remote: path: CapyKit/CapyEvent.cs branch: main repo: https://git.jordanwages.com/wagesj45/CapyKit.git id: Unsubscribe path: ../CapyKit/CapyEvent.cs startLine: 66 assemblies: - CapyKit namespace: CapyKit summary: Unsubscribes the specified event handler from the event with the given origin. example: [] syntax: content: public static void Unsubscribe(CapyEventHandler callback, string origin) parameters: - id: callback type: CapyKit.CapyEventHandler description: The event handler to unsubscribe. - id: origin type: System.String description: The name of the method or class where the subscription was made. content.vb: Public Shared Sub Unsubscribe(callback As CapyEventHandler, origin As String) overload: CapyKit.CapyEventReporter.Unsubscribe* nameWithType.vb: CapyEventReporter.Unsubscribe(CapyEventHandler, String) fullName.vb: CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler, String) name.vb: Unsubscribe(CapyEventHandler, String) - uid: CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[]) commentId: M:CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[]) id: EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[]) parent: CapyKit.CapyEventReporter langs: - csharp - vb name: EmitEvent(EventLevel, string, string, params object[]) nameWithType: CapyEventReporter.EmitEvent(EventLevel, string, string, params object[]) fullName: CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel, string, string, params object[]) type: Method source: remote: path: CapyKit/CapyEvent.cs branch: main repo: https://git.jordanwages.com/wagesj45/CapyKit.git id: EmitEvent path: ../CapyKit/CapyEvent.cs startLine: 99 assemblies: - CapyKit namespace: CapyKit summary: Emits an event with the given severity level, message, and method name. remarks: >- In order to allow for efficient calling member access via , it is suggested that args is defined explicitly for formatted messages. example: - '
CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration });
' syntax: content: public static void EmitEvent(EventLevel eventLevel, string message, string method = null, params object[] args) parameters: - id: eventLevel type: CapyKit.EventLevel description: The severity level of the event. - id: message type: System.String description: >- The message describing the reason for the event. String formatting for args is accepted. - id: method type: System.String description: (Optional) The name of the method where the event was raised. - id: args type: System.Object[] description: A variable-length parameters list containing arguments for formatting the message. content.vb: Public Shared Sub EmitEvent(eventLevel As EventLevel, message As String, method As String = Nothing, ParamArray args As Object()) overload: CapyKit.CapyEventReporter.EmitEvent* seealso: - linkId: System.Runtime.CompilerServices.CallerMemberNameAttribute commentId: T:System.Runtime.CompilerServices.CallerMemberNameAttribute nameWithType.vb: CapyEventReporter.EmitEvent(EventLevel, String, String, ParamArray Object()) fullName.vb: CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel, String, String, ParamArray Object()) name.vb: EmitEvent(EventLevel, String, String, ParamArray Object()) - uid: CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[]) commentId: M:CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[]) id: EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[]) parent: CapyKit.CapyEventReporter langs: - csharp - vb name: EmitEventOnce(EventLevel, string, string, string, params object[]) nameWithType: CapyEventReporter.EmitEventOnce(EventLevel, string, string, string, params object[]) fullName: CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel, string, string, string, params object[]) type: Method source: remote: path: CapyKit/CapyEvent.cs branch: main repo: https://git.jordanwages.com/wagesj45/CapyKit.git id: EmitEventOnce path: ../CapyKit/CapyEvent.cs startLine: 139 assemblies: - CapyKit namespace: CapyKit summary: >- Emits an event with the given severity level, message, unique identifier, and method name one time. remarks: >- This method is similar to EmitEvent(EventLevel, string, string, string, object[]) , but requires a unique identifier (such as a ) to prevent duplicate emissions. example: [] syntax: content: public static void EmitEventOnce(EventLevel eventLevel, string message, string uniqueIdentifier, string method = null, params object[] args) parameters: - id: eventLevel type: CapyKit.EventLevel description: The severity level of the event. - id: message type: System.String description: >- The message describing the reason for the event. String formatting for args is accepted. - id: uniqueIdentifier type: System.String description: A unique identifier for the event emission. - id: method type: System.String description: (Optional) The name of the method where the event was raised. - id: args type: System.Object[] description: A variable-length parameters list containing arguments for formatting the message. content.vb: Public Shared Sub EmitEventOnce(eventLevel As EventLevel, message As String, uniqueIdentifier As String, method As String = Nothing, ParamArray args As Object()) overload: CapyKit.CapyEventReporter.EmitEventOnce* seealso: - linkId: System.Runtime.CompilerServices.CallerMemberNameAttribute commentId: T:System.Runtime.CompilerServices.CallerMemberNameAttribute - linkId: System.Guid commentId: T:System.Guid nameWithType.vb: CapyEventReporter.EmitEventOnce(EventLevel, String, String, String, ParamArray Object()) fullName.vb: CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel, String, String, String, ParamArray Object()) name.vb: EmitEventOnce(EventLevel, String, String, String, ParamArray Object()) references: - uid: CapyKit.CapyEventReporter commentId: T:CapyKit.CapyEventReporter href: CapyKit.CapyEventReporter.html name: CapyEventReporter nameWithType: CapyEventReporter fullName: CapyKit.CapyEventReporter - uid: CapyKit commentId: N:CapyKit href: CapyKit.html name: CapyKit nameWithType: CapyKit fullName: CapyKit - uid: System.Object commentId: T:System.Object parent: System isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object name: object nameWithType: object fullName: object nameWithType.vb: Object fullName.vb: Object name.vb: Object - uid: System.Object.Equals(System.Object) commentId: M:System.Object.Equals(System.Object) parent: System.Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) name: Equals(object) nameWithType: object.Equals(object) fullName: object.Equals(object) nameWithType.vb: Object.Equals(Object) fullName.vb: Object.Equals(Object) name.vb: Equals(Object) spec.csharp: - uid: System.Object.Equals(System.Object) name: Equals isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) - name: ( - uid: System.Object name: object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object - name: ) spec.vb: - uid: System.Object.Equals(System.Object) name: Equals isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) - name: ( - uid: System.Object name: Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object - name: ) - uid: System.Object.Equals(System.Object,System.Object) commentId: M:System.Object.Equals(System.Object,System.Object) parent: System.Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) name: Equals(object, object) nameWithType: object.Equals(object, object) fullName: object.Equals(object, object) nameWithType.vb: Object.Equals(Object, Object) fullName.vb: Object.Equals(Object, Object) name.vb: Equals(Object, Object) spec.csharp: - uid: System.Object.Equals(System.Object,System.Object) name: Equals isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) - name: ( - uid: System.Object name: object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object - name: ',' - name: " " - uid: System.Object name: object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object - name: ) spec.vb: - uid: System.Object.Equals(System.Object,System.Object) name: Equals isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) - name: ( - uid: System.Object name: Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object - name: ',' - name: " " - uid: System.Object name: Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object - name: ) - uid: System.Object.GetHashCode commentId: M:System.Object.GetHashCode parent: System.Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode name: GetHashCode() nameWithType: object.GetHashCode() fullName: object.GetHashCode() nameWithType.vb: Object.GetHashCode() fullName.vb: Object.GetHashCode() spec.csharp: - uid: System.Object.GetHashCode name: GetHashCode isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode - name: ( - name: ) spec.vb: - uid: System.Object.GetHashCode name: GetHashCode isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode - name: ( - name: ) - uid: System.Object.GetType commentId: M:System.Object.GetType parent: System.Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.gettype name: GetType() nameWithType: object.GetType() fullName: object.GetType() nameWithType.vb: Object.GetType() fullName.vb: Object.GetType() spec.csharp: - uid: System.Object.GetType name: GetType isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.gettype - name: ( - name: ) spec.vb: - uid: System.Object.GetType name: GetType isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.gettype - name: ( - name: ) - uid: System.Object.MemberwiseClone commentId: M:System.Object.MemberwiseClone parent: System.Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone name: MemberwiseClone() nameWithType: object.MemberwiseClone() fullName: object.MemberwiseClone() nameWithType.vb: Object.MemberwiseClone() fullName.vb: Object.MemberwiseClone() spec.csharp: - uid: System.Object.MemberwiseClone name: MemberwiseClone isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone - name: ( - name: ) spec.vb: - uid: System.Object.MemberwiseClone name: MemberwiseClone isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone - name: ( - name: ) - uid: System.Object.ReferenceEquals(System.Object,System.Object) commentId: M:System.Object.ReferenceEquals(System.Object,System.Object) parent: System.Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals name: ReferenceEquals(object, object) nameWithType: object.ReferenceEquals(object, object) fullName: object.ReferenceEquals(object, object) nameWithType.vb: Object.ReferenceEquals(Object, Object) fullName.vb: Object.ReferenceEquals(Object, Object) name.vb: ReferenceEquals(Object, Object) spec.csharp: - uid: System.Object.ReferenceEquals(System.Object,System.Object) name: ReferenceEquals isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals - name: ( - uid: System.Object name: object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object - name: ',' - name: " " - uid: System.Object name: object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object - name: ) spec.vb: - uid: System.Object.ReferenceEquals(System.Object,System.Object) name: ReferenceEquals isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals - name: ( - uid: System.Object name: Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object - name: ',' - name: " " - uid: System.Object name: Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object - name: ) - uid: System.Object.ToString commentId: M:System.Object.ToString parent: System.Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.tostring name: ToString() nameWithType: object.ToString() fullName: object.ToString() nameWithType.vb: Object.ToString() fullName.vb: Object.ToString() spec.csharp: - uid: System.Object.ToString name: ToString isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.tostring - name: ( - name: ) spec.vb: - uid: System.Object.ToString name: ToString isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object.tostring - name: ( - name: ) - uid: System commentId: N:System isExternal: true href: https://learn.microsoft.com/dotnet/api/system name: System nameWithType: System fullName: System - uid: CapyKit.CapyEventReporter.Subscribe* commentId: Overload:CapyKit.CapyEventReporter.Subscribe href: CapyKit.CapyEventReporter.html#CapyKit_CapyEventReporter_Subscribe_CapyKit_CapyEventHandler_CapyKit_EventLevel_System_String_ name: Subscribe nameWithType: CapyEventReporter.Subscribe fullName: CapyKit.CapyEventReporter.Subscribe - uid: CapyKit.CapyEventHandler commentId: T:CapyKit.CapyEventHandler parent: CapyKit href: CapyKit.CapyEventHandler.html name: CapyEventHandler nameWithType: CapyEventHandler fullName: CapyKit.CapyEventHandler - uid: CapyKit.EventLevel commentId: T:CapyKit.EventLevel parent: CapyKit href: CapyKit.EventLevel.html name: EventLevel nameWithType: EventLevel fullName: CapyKit.EventLevel - uid: System.String commentId: T:System.String parent: System isExternal: true href: https://learn.microsoft.com/dotnet/api/system.string name: string nameWithType: string fullName: string nameWithType.vb: String fullName.vb: String name.vb: String - uid: CapyKit.CapyEventReporter.Unsubscribe* commentId: Overload:CapyKit.CapyEventReporter.Unsubscribe href: CapyKit.CapyEventReporter.html#CapyKit_CapyEventReporter_Unsubscribe_CapyKit_CapyEventHandler_System_String_ name: Unsubscribe nameWithType: CapyEventReporter.Unsubscribe fullName: CapyKit.CapyEventReporter.Unsubscribe - uid: System.Runtime.CompilerServices.CallerMemberNameAttribute commentId: T:System.Runtime.CompilerServices.CallerMemberNameAttribute isExternal: true href: https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute name: CallerMemberNameAttribute nameWithType: CallerMemberNameAttribute fullName: System.Runtime.CompilerServices.CallerMemberNameAttribute - uid: CapyKit.CapyEventReporter.EmitEvent* commentId: Overload:CapyKit.CapyEventReporter.EmitEvent href: CapyKit.CapyEventReporter.html#CapyKit_CapyEventReporter_EmitEvent_CapyKit_EventLevel_System_String_System_String_System_Object___ name: EmitEvent nameWithType: CapyEventReporter.EmitEvent fullName: CapyKit.CapyEventReporter.EmitEvent - uid: System.Object[] isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object name: object[] nameWithType: object[] fullName: object[] nameWithType.vb: Object() fullName.vb: Object() name.vb: Object() spec.csharp: - uid: System.Object name: object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object - name: '[' - name: ']' spec.vb: - uid: System.Object name: Object isExternal: true href: https://learn.microsoft.com/dotnet/api/system.object - name: ( - name: ) - uid: System.Guid commentId: T:System.Guid isExternal: true href: https://learn.microsoft.com/dotnet/api/system.guid name: Guid nameWithType: Guid fullName: System.Guid - uid: CapyKit.CapyEventReporter.EmitEventOnce* commentId: Overload:CapyKit.CapyEventReporter.EmitEventOnce href: CapyKit.CapyEventReporter.html#CapyKit_CapyEventReporter_EmitEventOnce_CapyKit_EventLevel_System_String_System_String_System_String_System_Object___ name: EmitEventOnce nameWithType: CapyEventReporter.EmitEventOnce fullName: CapyKit.CapyEventReporter.EmitEventOnce