Represents the basic settings for an IC user.

Namespace: ININ.IceLib.People
Assembly: ININ.IceLib.People (in ININ.IceLib.People.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public class UserSettings
Visual Basic
Public Class UserSettings

Remarks

Derived classes must invoke the public constructor.
CopyC#
public class MyUserSettings : UserSettings
{
    public MyUserSettings(PeopleManager peopleManager) : base(peopleManager)
    {
    }
...
}

This class implements a watched attribute object for basic user settings for an IC user.

To start a watch call StartWatching(array<String>[]()[][]) or StartWatchingAsync(array<String>[]()[][], AsyncCompletedEventHandler, Object) with an array of attributes to watch. When the asynchronous start watch completes the completedCallback delegate is invoked. To stop a watch call StopWatching()()()() or StopWatchingAsync(AsyncCompletedEventHandler, Object). When the asynchronous stop watch operation completes, the completedCallback delegate is invoked. To change the list of attributes that are watched call the ChangeWatchedAttributes(array<String>[]()[][], array<String>[]()[][], Boolean) or ChangeWatchedAttributesAsync(array<String>[]()[][], array<String>[]()[][], Boolean, AsyncCompletedEventHandler, Object) with the new array of attributes to watch. When the asynchronous change watching operation completes, the completedCallback delegate is invoked.

When an attribute changes, the WatchedAttributesChanged event is triggered providing information about which attributes have changed.

Calling StartWatching(array<String>[]()[][]) or StartWatchingAsync(array<String>[]()[][], AsyncCompletedEventHandler, Object) when a watch is already in place, or calling StopWatching()()()(), StopWatchingAsync(AsyncCompletedEventHandler, Object), ChangeWatchedAttributes(array<String>[]()[][], array<String>[]()[][], Boolean), or ChangeWatchedAttributesAsync(array<String>[]()[][], array<String>[]()[][], Boolean, AsyncCompletedEventHandler, Object) when a watch is not in place, raises the InvalidOperationException.

Accessing a property for an attribute that is not being watched raises the NotCachedException.

Note
The asynchronous version of these methods is preferred since the start, stop, and change watch operations can be lengthy.

Inheritance Hierarchy

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.

See Also