Class Alert
Represents an alert generated according to some rules defined in the system.
Inherited Members
Namespace: Nevatech.Vsb.Repository.Entities
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public sealed class Alert : DomainObjectBase, IValidator, IExtensibleDataObject, IEquatable<Alert>Constructors
Alert()
Declaration
public Alert()Properties
AlertDateTime
Gets or sets the date and time (UTC) when alert has been generated.
Declaration
public DateTime AlertDateTime { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime |
AlertSourceTypeId
Gets the alert source type identifier.
Declaration
public int AlertSourceTypeId { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
AlertSourceTypeName
Gets the alert source type display name.
Declaration
public string AlertSourceTypeName { get; }Property Value
| Type | Description |
|---|---|
| String |
AlertSubtype
Gets or sets the identifier of alert subtype. The subtype is used to distinguish alerts of the same type. For example, subtype can be X.509 certificate thumbprint telling that alerts are coming from the same or different certificate. Or subtype can be service agreement metric name which allows to subgroup alerts by particular metric within the same alert type. The FrequencyTimeInterval is applied to each individual subtype.
Declaration
public string AlertSubtype { get; set; }Property Value
| Type | Description |
|---|---|
| String |
AlertTypeId
Gets or sets the identifier of alert type.
Declaration
public int AlertTypeId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
AlertTypeName
Gets the alert type display name.
Declaration
public string AlertTypeName { get; }Property Value
| Type | Description |
|---|---|
| String |
Data
Gets collection of the optional properties attached to the alert. For example, it may contain X.509 certificate name or identifier of service agreement violation.
Declaration
public DataPropertyCollection Data { get; }Property Value
| Type | Description |
|---|---|
| DataPropertyCollection |
Description
Gets or sets the alert text message.
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| String |
IsObserved
Gets or sets flag indicating that alert has been observed by an administrator (set up manually).
Declaration
public bool IsObserved { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
ObjectType
Gets object type identifier.
Declaration
public override EntityType ObjectType { get; }Property Value
| Type | Description |
|---|---|
| EntityType |
Overrides
Methods
Equals(Alert)
Determines whether the specified object is equal to the current object.
Declaration
public bool Equals(Alert other)Parameters
| Type | Name | Description |
|---|---|---|
| Alert | other | The object to compare with the current object. |
Returns
| Type | Description |
|---|---|
| Boolean | True, if objects are equal. False, if objects are not equal. |
Equals(Object)
Determines whether the specified object is equal to the current object.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| Object | obj | The object to compare with the current object. |
Returns
| Type | Description |
|---|---|
| Boolean | True, if objects are equal. False, if objects are not equal. |
Overrides
GetHashCode()
Returns the hash code for this instance.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| Int32 | Hash code of the current instance. |
Overrides
Validate()
Evaluates the state of this object.
Declaration
public override bool Validate()Returns
| Type | Description |
|---|---|
| Boolean | True if state is valid; otherwise, false. |
Overrides
Write(IFormatProvider, String)
Writes alert properties into a string according to the specified template.
Declaration
public string Write(IFormatProvider provider, string format)Parameters
| Type | Name | Description |
|---|---|---|
| IFormatProvider | provider | Format provider that supplies culture-specific formatting information. |
| String | format | Template string that is used to write alert properties. |
Returns
| Type | Description |
|---|---|
| String | String containing alert properties serialized according to the specified template string. |
Remarks
The standard format string tokens:
Auditing-specific tokens:
Service Agreement violations-specific tokens:
Developer Portal new user created event tokens:
Developer Portal user reset password event tokens:
Developer Portal user forgot user-name event tokens:
Developer Portal new consumer created event tokens:
New subscription created or subscription pending activation events tokens:
Subscription activated event tokens:
Subscription pending expiration event tokens:
Write(TextWriter, String)
Writes alert properties into provided text writer a according to the specified template.
Declaration
public void Write(TextWriter writer, string format)Parameters
| Type | Name | Description |
|---|---|---|
| TextWriter | writer | Text writer to write into. |
| String | format | Template string that is used to write alert properties. |
Remarks
See token's description on method's overload.