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 | |
---|---|---|
ActivateUserTaskContextString | Gets the displayed message when a user's extension is activated. |
|
ActivateUserTaskInProgressMessage | Gets the displayed message in the progress window when a user's extension is being activated. |
|
ActivateUserTaskInProgressTitle | Gets the title of the progress window when a user's extension is being activated. |
|
AddUserPropertiesFailureGenericErrorMessage | Gets the generic error message for a failure when adding user properties. |
|
AddUserPropertiesFailureWizardTitle | Gets the wizard title for a failure when adding user properties. |
|
AddUserWizardAssignExistingUserOptionText | Gets the description for the assigning existing user option from the Add User Wizard Extension page. |
|
AddUserWizardCreateUserOptionDescription | Gets the create user option description from the Add User Wizard Extension page. |
|
AddUserWizardCreateUserOptionText | Gets the description for the creating user option from the Add User Wizard Extension page. |
|
AddUserWizardHelpLinkText | Gets the description for the help link from the Add User Wizard Extension page. |
|
AddUserWizardHelpLinkUrl | Gets the URL for the help link from the Add User Wizard Extension page. |
|
AddUserWizardNoAccessOptionText | Gets the description for the no access option from the Add User Wizard Extension page. |
|
AddUserWizardNoAvailableEmailAccountsString | Gets the message if there are no available email accounts left after the user called GetAvailableEmailAccountsAsync. |
|
AddUserWizardNoAvailableEmailLoadingString | Gets the description when GetAvailableEmailAccountsAsync is running. |
|
AddUserWizardTabTitle | Gets the title of the Add User Wizard Extension page. |
|
AssignDeactivatedOnlineUserConfirmationDialogTitle | Gets the title of the confirmation dialog box when assigning a local user to a deactivated online user. |
|
AssignDeactivatedOnlineUserConfirmationMessage | Gets the confirmation window message when assigning a local user to a deactivated online user. |
|
AssignDeactivatedOnlineUserConfirmationTitle | Gets the confirmation window title when assigning a local user to a deactivated online user. |
|
AvailableDomains | Gets a list of available domains. |
|
DeactivateUserTaskContextString | Gets the message displayed when a user's extension is deactivated. |
|
DeactivateUserTaskInProgressMessage | Gets the progress window message when a user's extension is being deactivated. |
|
DeactivateUserTaskInProgressTitle | Gets the title of the progress window when a user's extension is being deactivated. |
|
DefaultDomainName | Gets the default domain name that belongs to the user extension properties. |
|
Enabled | Gets a Boolean value that indicates whether a user extension is enabled. |
|
MaximumPasswordLength | Gets the maximum length of a user's password. |
|
MinimumPasswordLength | Gets the minimum length of a user's password. |
|
PasswordLengthCriteriaString | Gets the description for the strong password length criteria. |
|
RemoveUserWizardTabInstruction | Gets the message displayed when a user's extension is removed. |
|
ResetPasswordFailureDialogTitle | Gets the title of the dialog box when resetting the user's password fails. |
|
ResetPasswordFailureMessage | Gets the dialog box message when resetting the user's password fails. |
|
ResetPasswordFailureSummary | Gets the summary when resetting the user's password fails. |
|
ResetPasswordProgressMessage | Gets the dialog box message when resetting the user's password. |
|
ResetPasswordProgressTitle | Gets the dialog box title when resetting the user's password. |
|
StrongPasswordPolicyDescription | Gets the description of the strong password policy. |
|
UserPropertiesTabActivateUserDescription | Gets the description for the Activate option on the User Extension Properties tab. |
|
UserPropertiesTabActivateUserString | Gets the description displayed for the Activate option on the User Extension Properties tab. |
|
UserPropertiesTabButtonAddString | Gets the description displayed for the Add button on the User Extension Properties tab.. |
|
UserPropertiesTabButtonDeleteString | Gets the description displayed for the Delete button on the User Extension Properties tab.. |
|
UserPropertiesTabButtonEditString | Gets the description displayed for the Edit button on the User Extension Properties tab.. |
|
UserPropertiesTabCreateUserButtonText | Gets the description displayed for the Activate button on the User Extension Properties tab. |
|
UserPropertiesTabCreateUserHintText | Gets the description displayed for the Activate button hint on the User Extension Properties tab. |
|
UserPropertiesTabDataLoadingString | Gets the description when GetUserPropertiesAsync is running. |
|
UserPropertiesTabDataRefreshButtonString | Gets the refresh button description on the User Extension Properties failure page. |
|
UserPropertiesTabDeactivateUserDescription | Gets the description displayed for the Deactivate option on the User Extension Properties tab. |
|
UserPropertiesTabDeactivateUserString | Gets the description displayed for the Deactivate option on the User Extension Properties tab. |
|
UserPropertiesTabEmailAddressesString | Gets the description displayed for the Email Address button on the User Extension Properties tab. |
|
UserPropertiesTabEmailAliasString | Gets the description displayed as the heading for the alias label. |
|
UserPropertiesTabHeading | Gets the tab heading text on the User Extension Properties tab. |
|
UserPropertiesTabHelpLinkText | Gets the description for the help link on the Add User Wizard Extension page. |
|
UserPropertiesTabHelpLinkUrl | Gets the URL for the help link on the Add User Wizard Extension page. |
Methods
Name | Description | |
---|---|---|
AddUserPropertiesAsync(IUserExtension2Properties, String) | Adds the extension properties asynchronously for a particular user. |
|
AddUserPropertiesWithExistingEmailAsync(IUserExtension2Properties, String, String) | Adds the extension properties asynchronously for a particular user who has the email address specified by the emailAddress parameter. |
|
CreateUserExtension2Properties() | Creates a new object that is used when adding the user extension properties. |
|
DeleteUserPropertiesAsync(String) | Deletes the extension properties asynchronously for a particular user. |
|
Dispose() | (Inherited from IDisposable.) |
|
GetAvailableEmailAccountsAsync() | Gets all the email accounts that are not mapped to existing users. |
|
GetUserPropertiesAsync(String) | Gets the extension properties asynchronously for a particular user. |
|
HideProgressWindow() | Hides the progress window. |
|
HideProgressWindow(Action) | Hides the progress window. |
|
IsLocalUserMapped(String) | Checks whether a local user is mapped to an online user. |
|
ResetUserPasswordAsync(String, String) | Resets the online password asynchronously for a particular user. |
|
RunAcitvateUserWizard(IUserExtension2Properties) | Runs a wizard to enable an on-premise user. |
|
SetUserActivateStateAysnc(String, Boolean) | Asynchronously sets the active state for the specified user. |
|
ShowProgressWindow(String, String) | Shows the progress window. |
|
UpdateUserPropertiesAsync(IUserExtension2Properties) | Updates the extension properties asynchronously for a particular user. |
|
ValidateEmailAddress(String, String, String) | Checks the user's email address for characters that are not valid. |
Events
Name | Description | |
---|---|---|
ActivateUserCompeleted | Represents the event that is raised when the RunAcitvateUserWizard method finishes. |
|
AddUserPropertiesCompleted | Represents the event that is raised when the AddUserPropertiesAsync method finishes. |
|
DeleteUserPropertiesCompleted | Represents the event that is raised when the DeleteUserPropertiesAsync method finishes. |
|
GetAvailableEmailAccountsCompleted | Represents the event that is raised when the GetAvailableEmailAccountsAsync method finishes. |
|
GetUserPropertiesCompleted | Represents the event that is raised when the GetUserPropertiesAsync method finishes. |
|
ResetUserPasswordCompeleted | Represents the event that is raised when the ResetUserPasswordAsync method finishes. |
|
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