Share via

IUserExtension2 Interface

 

The extension point for user properties in the product.

Namespace:   Microsoft.WindowsServerSolutions.Common
Assembly:  MiscUtil (in MiscUtil.dll)

Syntax

public interface IUserExtension2 : IDisposable

public interface class IUserExtension2 : IDisposable

Public Interface IUserExtension2
    Inherits IDisposable

Properties

Name Description
System_CAPS_pubproperty ActivateUserTaskContextString

Gets the displayed message when a user's extension is activated.
System_CAPS_pubproperty ActivateUserTaskInProgressMessage

Gets the displayed message in the progress window when a user's extension is being activated.
System_CAPS_pubproperty ActivateUserTaskInProgressTitle

Gets the title of the progress window when a user's extension is being activated.
System_CAPS_pubproperty AddUserPropertiesFailureGenericErrorMessage

Gets the generic error message for a failure when adding user properties.
System_CAPS_pubproperty AddUserPropertiesFailureWizardTitle

Gets the wizard title for a failure when adding user properties.
System_CAPS_pubproperty AddUserWizardAssignExistingUserOptionText

Gets the description for the assigning existing user option from the Add User Wizard Extension page.
System_CAPS_pubproperty AddUserWizardCreateUserOptionDescription

Gets the create user option description from the Add User Wizard Extension page.
System_CAPS_pubproperty AddUserWizardCreateUserOptionText

Gets the description for the creating user option from the Add User Wizard Extension page.
System_CAPS_pubproperty AddUserWizardHelpLinkText

Gets the description for the help link from the Add User Wizard Extension page.
System_CAPS_pubproperty AddUserWizardHelpLinkUrl

Gets the URL for the help link from the Add User Wizard Extension page.
System_CAPS_pubproperty AddUserWizardNoAccessOptionText

Gets the description for the no access option from the Add User Wizard Extension page.
System_CAPS_pubproperty AddUserWizardNoAvailableEmailAccountsString

Gets the message if there are no available email accounts left after the user called GetAvailableEmailAccountsAsync.
System_CAPS_pubproperty AddUserWizardNoAvailableEmailLoadingString

Gets the description when GetAvailableEmailAccountsAsync is running.
System_CAPS_pubproperty AddUserWizardTabTitle

Gets the title of the Add User Wizard Extension page.
System_CAPS_pubproperty AssignDeactivatedOnlineUserConfirmationDialogTitle

Gets the title of the confirmation dialog box when assigning a local user to a deactivated online user.
System_CAPS_pubproperty AssignDeactivatedOnlineUserConfirmationMessage

Gets the confirmation window message when assigning a local user to a deactivated online user.
System_CAPS_pubproperty AssignDeactivatedOnlineUserConfirmationTitle

Gets the confirmation window title when assigning a local user to a deactivated online user.
System_CAPS_pubproperty AvailableDomains

Gets a list of available domains.
System_CAPS_pubproperty DeactivateUserTaskContextString

Gets the message displayed when a user's extension is deactivated.
System_CAPS_pubproperty DeactivateUserTaskInProgressMessage

Gets the progress window message when a user's extension is being deactivated.
System_CAPS_pubproperty DeactivateUserTaskInProgressTitle

Gets the title of the progress window when a user's extension is being deactivated.
System_CAPS_pubproperty DefaultDomainName

Gets the default ___domain name that belongs to the user extension properties.
System_CAPS_pubproperty Enabled

Gets a Boolean value that indicates whether a user extension is enabled.
System_CAPS_pubproperty MaximumPasswordLength

Gets the maximum length of a user's password.
System_CAPS_pubproperty MinimumPasswordLength

Gets the minimum length of a user's password.
System_CAPS_pubproperty PasswordLengthCriteriaString

Gets the description for the strong password length criteria.
System_CAPS_pubproperty RemoveUserWizardTabInstruction

Gets the message displayed when a user's extension is removed.
System_CAPS_pubproperty ResetPasswordFailureDialogTitle

Gets the title of the dialog box when resetting the user's password fails.
System_CAPS_pubproperty ResetPasswordFailureMessage

Gets the dialog box message when resetting the user's password fails.
System_CAPS_pubproperty ResetPasswordFailureSummary

Gets the summary when resetting the user's password fails.
System_CAPS_pubproperty ResetPasswordProgressMessage

Gets the dialog box message when resetting the user's password.
System_CAPS_pubproperty ResetPasswordProgressTitle

Gets the dialog box title when resetting the user's password.
System_CAPS_pubproperty StrongPasswordPolicyDescription

Gets the description of the strong password policy.
System_CAPS_pubproperty UserPropertiesTabActivateUserDescription

Gets the description for the Activate option on the User Extension Properties tab.
System_CAPS_pubproperty UserPropertiesTabActivateUserString

Gets the description displayed for the Activate option on the User Extension Properties tab.
System_CAPS_pubproperty UserPropertiesTabButtonAddString

Gets the description displayed for the Add button on the User Extension Properties tab..
System_CAPS_pubproperty UserPropertiesTabButtonDeleteString

Gets the description displayed for the Delete button on the User Extension Properties tab..
System_CAPS_pubproperty UserPropertiesTabButtonEditString

Gets the description displayed for the Edit button on the User Extension Properties tab..
System_CAPS_pubproperty UserPropertiesTabCreateUserButtonText

Gets the description displayed for the Activate button on the User Extension Properties tab.
System_CAPS_pubproperty UserPropertiesTabCreateUserHintText

Gets the description displayed for the Activate button hint on the User Extension Properties tab.
System_CAPS_pubproperty UserPropertiesTabDataLoadingString

Gets the description when GetUserPropertiesAsync is running.
System_CAPS_pubproperty UserPropertiesTabDataRefreshButtonString

Gets the refresh button description on the User Extension Properties failure page.
System_CAPS_pubproperty UserPropertiesTabDeactivateUserDescription

Gets the description displayed for the Deactivate option on the User Extension Properties tab.
System_CAPS_pubproperty UserPropertiesTabDeactivateUserString

Gets the description displayed for the Deactivate option on the User Extension Properties tab.
System_CAPS_pubproperty UserPropertiesTabEmailAddressesString

Gets the description displayed for the Email Address button on the User Extension Properties tab.
System_CAPS_pubproperty UserPropertiesTabEmailAliasString

Gets the description displayed as the heading for the alias label.
System_CAPS_pubproperty UserPropertiesTabHeading

Gets the tab heading text on the User Extension Properties tab.
System_CAPS_pubproperty UserPropertiesTabHelpLinkText

Gets the description for the help link on the Add User Wizard Extension page.
System_CAPS_pubproperty UserPropertiesTabHelpLinkUrl

Gets the URL for the help link on the Add User Wizard Extension page.

Methods

Name Description
System_CAPS_pubmethod AddUserPropertiesAsync(IUserExtension2Properties, String)

Adds the extension properties asynchronously for a particular user.
System_CAPS_pubmethod AddUserPropertiesWithExistingEmailAsync(IUserExtension2Properties, String, String)

Adds the extension properties asynchronously for a particular user who has the email address specified by the emailAddress parameter.
System_CAPS_pubmethod CreateUserExtension2Properties()

Creates a new object that is used when adding the user extension properties.
System_CAPS_pubmethod DeleteUserPropertiesAsync(String)

Deletes the extension properties asynchronously for a particular user.
System_CAPS_pubmethod Dispose()

(Inherited from IDisposable.)
System_CAPS_pubmethod GetAvailableEmailAccountsAsync()

Gets all the email accounts that are not mapped to existing users.
System_CAPS_pubmethod GetUserPropertiesAsync(String)

Gets the extension properties asynchronously for a particular user.
System_CAPS_pubmethod HideProgressWindow()

Hides the progress window.
System_CAPS_pubmethod HideProgressWindow(Action)

Hides the progress window.
System_CAPS_pubmethod IsLocalUserMapped(String)

Checks whether a local user is mapped to an online user.
System_CAPS_pubmethod ResetUserPasswordAsync(String, String)

Resets the online password asynchronously for a particular user.
System_CAPS_pubmethod RunAcitvateUserWizard(IUserExtension2Properties)

Runs a wizard to enable an on-premise user.
System_CAPS_pubmethod SetUserActivateStateAysnc(String, Boolean)

Asynchronously sets the active state for the specified user.
System_CAPS_pubmethod ShowProgressWindow(String, String)

Shows the progress window.
System_CAPS_pubmethod UpdateUserPropertiesAsync(IUserExtension2Properties)

Updates the extension properties asynchronously for a particular user.
System_CAPS_pubmethod ValidateEmailAddress(String, String, String)

Checks the user's email address for characters that are not valid.

Events

Name Description
System_CAPS_pubevent ActivateUserCompeleted

Represents the event that is raised when the RunAcitvateUserWizard method finishes.
System_CAPS_pubevent AddUserPropertiesCompleted

Represents the event that is raised when the AddUserPropertiesAsync method finishes.
System_CAPS_pubevent DeleteUserPropertiesCompleted

Represents the event that is raised when the DeleteUserPropertiesAsync method finishes.
System_CAPS_pubevent GetAvailableEmailAccountsCompleted

Represents the event that is raised when the GetAvailableEmailAccountsAsync method finishes.
System_CAPS_pubevent GetUserPropertiesCompleted

Represents the event that is raised when the GetUserPropertiesAsync method finishes.
System_CAPS_pubevent ResetUserPasswordCompeleted

Represents the event that is raised when the ResetUserPasswordAsync method finishes.
System_CAPS_pubevent UpdateUserPropertiesCompleted

Represents the event that is raised when the UpdateUserPropertiesAsync method finishes.

Remarks

This is only available on Windows Small Business Server 2011.

See Also

Microsoft.WindowsServerSolutions.Common Namespace

Return to top