AlertService Class

The standard platform alert service. Currently alerts are provided via AJAX while users are logged into the application.

Inheritance Hierarchy

SystemObject
NetQuarry.ServicesServiceBase
NetQuarry.ServicesAlertService

Namespace: NetQuarry.Services
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)

Syntax

Copy

[SerializableAttribute]
public class AlertService : ServiceBase, 
	IAlertService

<SerializableAttribute>
Public Class AlertService
	Inherits ServiceBase
	Implements IAlertService

The AlertService type exposes the following members.

Constructors

	Name	Description
	AlertService	Initializes a new instance of the AlertService class

Top

Properties

	Name	Description
	Application	Gets or Sets the IAppContext object for the service. (Inherited from ServiceBase.)
	Attributes	Gets/Sets the service attributes. (Inherited from ServiceBase.)
	Category	Gets/Sets the service category. (Inherited from ServiceBase.)
	ComponentID	Gets/Sets the service component ID. (Inherited from ServiceBase.)
	ID	Gets/Sets the service ID. (Inherited from ServiceBase.)
	Name	Gets/Sets the service name. (Inherited from ServiceBase.)
	Properties	Gets the service's configuration properties (Inherited from ServiceBase.)
	Settings	Gets the alert configuration settings for the service.
	Type	Gets/Sets the service type. (Inherited from ServiceBase.)

Top

Methods

	Name	Description
	Clone	Returns a copy of this object (Inherited from ServiceBase.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnWebhook	Handles an invocation of a "webhook" event for the service. You should implement this event if you want your service to handle webhooks through the standard platform webhook wiring. The raw wiring for the webhook would look like handler.ashx?req=webhook&service=sss&appkey=aaa&token=ttt where sss is the name of the service, aaa is the application key, and ttt is the authentication token. When wired up in the manner, the platform will instantiate an IAppContext object, authenticate the request based on the provided token, obtain an instance of the service from the Services collection, and invoke this method on the service. If the webhook is wired up in this manner, you must override the base implementation of this method or an exception will be thrown. (Inherited from ServiceBase.)
	Send(String, String, String, String)	Send an alert immediately, and without expiration, to the specified user.
	Send(String, String, String, String, NullableDateTime)	Send an alert at the specified date/time (and without expiration) to the specified user.
	Send(String, String, String, String, NullableTimeSpan)	Send an alert immediately, but only if deliverable within the specified date/time window.
	Send(String, String, String, String, String)	Send an alert immediately, and without expiration, to the specified user.
	Send(String, String, String, String, NullableDateTime, NullableDateTime)	Send an alert to the specified user at the specified date/time, but only until the specified expiration date/time.
	Send(String, String, String, String, NullableDateTime, NullableTimeSpan)	Send an alert at the specified date/time, but only if deliverable within the specified date/time window.
	Send(String, String, String, String, String, NullableDateTime)	Send an alert at the specified date/time (and without expiration) to the specified user.
	Send(String, String, String, String, String, NullableTimeSpan)	Send an alert immediately, but only if deliverable within the specified date/time window.
	Send(String, String, String, String, String, NullableDateTime, NullableDateTime)	Send an alert to the specified user.
	Send(String, String, String, String, String, NullableDateTime, NullableTimeSpan)	Send an alert at the specified date/time, but only if deliverable within the specified date/time window.
	ServiceLoaded	Called by the ServiceInfos collection after the service is created (Inherited from ServiceBase.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	EqualValue	Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used. (Defined by EAPUtil.)

Top

Reference

NetQuarry.Services Namespace