Class UserConfiguration

Namespace

Microsoft.Exchange.WebServices.Data

Assembly

Microsoft.Exchange.WebServices.dll

Represents an object that can be used to store user-defined configuration settings.

public class UserConfiguration

Inheritance

object

UserConfiguration

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

UserConfiguration(ExchangeService)

Initializes a new instance of UserConfiguration class.

public UserConfiguration(ExchangeService service)

Parameters

service ExchangeService

The service to which the user configuration is bound.

Properties

BinaryData

Gets or sets the binary data of the user configuration.

public byte[] BinaryData { get; set; }

Property Value

byte[]

Dictionary

Gets the dictionary of the user configuration.

public UserConfigurationDictionary Dictionary { get; }

Property Value

UserConfigurationDictionary

IsDirty

Gets a value indicating whether this user configuration has been modified.

public bool IsDirty { get; }

Property Value

bool

ItemId

Gets the Id of the user configuration.

public ItemId ItemId { get; }

Property Value

ItemId

Name

Gets the name of the user configuration.

public string Name { get; }

Property Value

string

ParentFolderId

Gets the Id of the folder containing the user configuration.

public FolderId ParentFolderId { get; }

Property Value

FolderId

XmlData

Gets or sets the xml data of the user configuration.

public byte[] XmlData { get; set; }

Property Value

byte[]

Methods

Bind(ExchangeService, string, FolderId, UserConfigurationProperties)

Binds to an existing user configuration and loads the specified properties. Calling this method results in a call to EWS.

public static UserConfiguration Bind(ExchangeService service, string name, FolderId parentFolderId, UserConfigurationProperties properties)

Parameters

service ExchangeService

The service to which the user configuration is bound.

name string

The name of the user configuration.

parentFolderId FolderId

The Id of the folder containing the user configuration.

properties UserConfigurationProperties

The properties to load.

Returns

UserConfiguration

A user configuration instance.

Bind(ExchangeService, string, WellKnownFolderName, UserConfigurationProperties)

Binds to an existing user configuration and loads the specified properties. Calling this method results in a call to EWS.

public static UserConfiguration Bind(ExchangeService service, string name, WellKnownFolderName parentFolderName, UserConfigurationProperties properties)

Parameters

service ExchangeService

The service to which the user configuration is bound.

name string

The name of the user configuration.

parentFolderName WellKnownFolderName

The name of the folder containing the user configuration.

properties UserConfigurationProperties

The properties to load.

Returns

UserConfiguration

A user configuration instance.

Delete()

Deletes the user configuration. Calling this method results in a call to EWS.

public void Delete()

Load(UserConfigurationProperties)

Loads the specified properties on the user configuration. Calling this method results in a call to EWS.

public void Load(UserConfigurationProperties properties)

Parameters

properties UserConfigurationProperties

The properties to load.

Save(string, FolderId)

Saves the user configuration. Calling this method results in a call to EWS.

public void Save(string name, FolderId parentFolderId)

Parameters

name string

The name of the user configuration.

parentFolderId FolderId

The Id of the folder in which to save the user configuration.

Save(string, WellKnownFolderName)

Saves the user configuration. Calling this method results in a call to EWS.

public void Save(string name, WellKnownFolderName parentFolderName)

Parameters

name string

The name of the user configuration.

parentFolderName WellKnownFolderName

The name of the folder in which to save the user configuration.

Update()

Updates the user configuration by applying local changes to the Exchange server. Calling this method results in a call to EWS.

public void Update()