Implementing IPluginHeartbeatTask

FogBugz Plugin Interfaces > FogBugz Periodic Maintenance > IPluginHeartbeatTask

Introduction

This article will demonstrate a simple FogBugz plugin that implements the IPluginHeartbeatTask interface contained in the FogCreek.FogBugz.Plugins.Interfaces class library.

Note: in any action that takes place during periodic maintenance, plugin code which loads FogBugz entities should assume it has only Public permissions. If your code needs to access and modify entities, use .IgnorePermissions as described here: Entity Member Security. When IgnorePermissions is set to true, heartbeat tasks have site admin permissions.

Functionality

This plugin will read the number of times heartbeat has been run from the plugin's key/value pair table, increment it and add an administrator notification with the current count:

Compile and Install It On Your Own

Download the source file:   IPluginHeartbeatTask_Example.cs

Then follow these instructions to create a functioning plugin assembly: Compiling and Installing a FogBugz Plugin