Share via

IFsrmFileManagementJob.AddNotification Method (Int32)

  • Article

 

Adds a new notification value (period) to the file management job's list of notifications.

Namespace:   Microsoft.Storage
Assembly:  srmlib (in srmlib.dll)

Syntax

void AddNotification(
    int days
)

void AddNotification(
    int days
)

abstract AddNotification : 
        days:int -> unit

Sub AddNotification (
    days As Integer
)

Parameters

  • days
    Type: System.Int32

    A unique notification value to add. The value cannot be less than zero.

Remarks

The days parameter specifies the number of days before the file is to expire. If the appropriate conditions set in the job are met, notification will be sent to the user to let them know that the file is about to expire. FSRM uses the actions associated with the notification value to determine how the user is notified.

Notification occurs when the job runs and the following conditions are met:

  1. Today is the day when notification should occur.

  2. The day when notification should occur is before the next scheduled run time.

Note that it is possible for the user to receive duplicate notifications. For example, the user can receive duplicate notifications if the job is run manually after the notification is sent but on or before the day when the notification should occur.

The FromDate determines when the notification window begins. The following properties determine when the file is to expire:

  1. DaysSinceFileCreated

  2. DaysSinceFileLastAccessed

  3. DaysSinceFileLastModified

  4. PropertyConditions (use the CreatePropertyCondition method to create the property condition)

  5. FileNamePattern

To associate an action with the notification value, call the CreateNotificationAction method.

See Also

DeleteNotification
ModifyNotification
Notifications
IFsrmFileManagementJob Interface
Microsoft.Storage Namespace

Return to top