CK-Text CK-Text
    Show / Hide Table of Contents

    Interface IActivityMonitorClient

    Listener for IActivityMonitor registered in a IActivityMonitorOutput.

    Namespace: CK.Core
    Assembly: CK.ActivityMonitor.dll
    Syntax
    public interface IActivityMonitorClient

    Methods

    | Improve this Doc View Source

    OnAutoTagsChanged(CKTrait)

    Called when AutoTags changed.

    Declaration
    void OnAutoTagsChanged(CKTrait newTrait)
    Parameters
    Type Name Description
    CK.Core.CKTrait newTrait

    The new tags (never null but can be empty).

    | Improve this Doc View Source

    OnGroupClosed(IActivityLogGroup, IReadOnlyList<ActivityLogGroupConclusion>)

    Called when the group is actually closed.

    Declaration
    void OnGroupClosed(IActivityLogGroup group, IReadOnlyList<ActivityLogGroupConclusion> conclusions)
    Parameters
    Type Name Description
    IActivityLogGroup group

    The closed group.

    IReadOnlyList<ActivityLogGroupConclusion> conclusions

    Texts that conclude the group. Never null but can be empty.

    | Improve this Doc View Source

    OnGroupClosing(IActivityLogGroup, ref List<ActivityLogGroupConclusion>)

    Called once the user conclusions are known at the group level but before the group is actually closed: clients can update the conclusions for the group. Does nothing by default.

    Declaration
    void OnGroupClosing(IActivityLogGroup group, ref List<ActivityLogGroupConclusion> conclusions)
    Parameters
    Type Name Description
    IActivityLogGroup group

    The closing group.

    List<ActivityLogGroupConclusion> conclusions

    Mutable conclusions associated to the closing group. This can be null if no conclusions have been added yet. It is up to the first client that wants to add a conclusion to instantiate a new List object to carry the conclusions.

    | Improve this Doc View Source

    OnOpenGroup(IActivityLogGroup)

    Called for each UnfilteredOpenGroup(ActivityMonitorGroupData).

    Declaration
    void OnOpenGroup(IActivityLogGroup group)
    Parameters
    Type Name Description
    IActivityLogGroup group

    The newly opened IActivityLogGroup.

    | Improve this Doc View Source

    OnTopicChanged(String, String, Int32)

    Called when a new Topic is set.

    Declaration
    void OnTopicChanged(string newTopic, string fileName, int lineNumber)
    Parameters
    Type Name Description
    String newTopic

    The new topic string (never null but can be empty).

    String fileName

    Source file name where SetTopic(String, String, Int32) has been called.

    Int32 lineNumber

    Source line number where IActivityMonitor.SetTopic has been called.

    | Improve this Doc View Source

    OnUnfilteredLog(ActivityMonitorLogData)

    Called for each UnfilteredLog(ActivityMonitorLogData). The Exception is always null since exceptions are carried by groups.

    Declaration
    void OnUnfilteredLog(ActivityMonitorLogData data)
    Parameters
    Type Name Description
    ActivityMonitorLogData data

    Log data. Never null.

    • Improve this Doc
    • View Source
    Back to top Copyright © 2015-2017 Invenietis
    Generated by DocFX