Class PortalNotificationConfiguration
Represents a simplified alert handler's configuration that enables or disables sending automated email messages to Developer Portal administrators in response to pre-defined events.
Implements
Inherited Members
Namespace: Nevatech.Vsb.Repository.Services
Assembly: Nevatech.Vsb.Repository.dll
Syntax
[DataContract(Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
public sealed class PortalNotificationConfiguration : IValidator
Constructors
PortalNotificationConfiguration()
Declaration
public PortalNotificationConfiguration()
Fields
SupportedAlertHandlers
Gets collection of alert handler's unique identifiers that can be used in this configuration.
Declaration
[SuppressMessage("Microsoft.Security", "CA2104:DoNotDeclareReadOnlyMutableReferenceTypes")]
public static readonly ReadOnlyCollection<Guid> SupportedAlertHandlers
Field Value
| Type | Description |
|---|---|
| ReadOnlyCollection<Guid> |
Properties
EnabledAlertHandlers
Gets collection of alert handler's unique identifiers that are currently enabled.
Declaration
[SuppressMessage("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
[DataMember]
public Collection<Guid> EnabledAlertHandlers { get; }
Property Value
| Type | Description |
|---|---|
| Collection<Guid> |
ErrorMessage
Gets the summary of validation errors populated by the call to Validate() method.
Declaration
public string ErrorMessage { get; }
Property Value
| Type | Description |
|---|---|
| string |
SecurityRoles
Gets collection of security roles identifiers which members will receive notification messages.
Declaration
[DataMember]
public Collection<int> SecurityRoles { get; }
Property Value
| Type | Description |
|---|---|
| Collection<int> |
ToAddresses
Gets or sets the string containing e-mail addresses of the message recipients.
Declaration
[DataMember(EmitDefaultValue = false)]
public string ToAddresses { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Examples
The format of the string is the following:
"Administrator <admin@test.com>, "Smith, John" <john.smith@test.com>"
Methods
Validate()
Validates this object's state.
Declaration
public bool Validate()
Returns
| Type | Description |
|---|---|
| bool | True if object's state is valid; otherwise, false. |