Click or drag to resize
PMBalanceUpdate Class
An update to a specific balance on a User, Group or OU
Inheritance Hierarchy
SystemObject
  PM90SettingsAPIPMBalanceUpdate

Namespace: PM90SettingsAPI
Assembly: PM90SettingsAPI (in PM90SettingsAPI.dll) Version: 9.0.23.534 (9.0.23.534)
Syntax
C#
Copy
public class Update

The PMBalanceUpdate type exposes the following members.

Methods
  NameDescription
Public methodDelete
Deletes this balance update from its User/Group/OU
Top
Fields
  NameDescription
Public fieldStatic memberLAST_DAY_OF_THE_MONTH
Always indicate balane update should occur on the last day of the month, even when a month has less than 31 days
Remarks
Value is 30 as is used as a 0 based index
Top
Properties
  NameDescription
Public propertyBalance
Gets the balance this update is associated with
Public propertyChange
Specifies if the update will reset, or increase
Public propertyCurrency
Current change when balance is of currency type
Public propertyInterval
Interval in quick recurence takes place when enabled
Public propertyPages
Pages change when balance is set to UsePages=true
Public propertyRecur
Specifies if this update is one time, or recurring
Public propertyRecurOn
Day of Week, or Day of Month recurrence happens on.
Public propertyUpdateTimeUTC
When the balance will update in UTC
Top
Examples
Example of listing, adding and deleting scheduled balance update.
Copy
PMGroupOU admins = PMGroupOU.LookupGroup("Administrators", "doamin.local");

//create a recurring reset on the last day of each month, for $100
admins.Balance.AddRecurringUpdate(PMBalance.Update.ChangeOption.Reset, PMBalance.Update.RecurringScheme.Monthly,

    new DateTime(2015, 1, 1, 0, 0, 0), //Only time part is relevent

    PMBalance.Update.LAST_DAY_OF_THE_MONTH, 100);


//Get current scheduled updates
var scheduledUpdates = admins.Balance.ScheduledUpdates;


//Remove update
scheduledUpdates[0].Delete();
See Also