IObjectPasswordProvider

Namespace: Lithnet.Ecma2Framework

Defines the methods and properties that a password provider must implement

public interface IObjectPasswordProvider

Methods

InitializeAsync(PasswordContext)

Initializes the password provider. This method is called once at the start of a batch of password operations

Task InitializeAsync(PasswordContext context)

Parameters

context PasswordContext The context of the operation

Returns

Task A task that represents the asynchronous operation

CanPerformPasswordOperationAsync(CSEntry)

Indicates whether the password provider can perform password operations on the specified object

Task<bool> CanPerformPasswordOperationAsync(CSEntry csentry)

Parameters

csentry CSEntry The CSEntry representing the object with the associated password change

Returns

Task<Boolean> if the provider can process the password change, otherwise

SetPasswordAsync(CSEntry, SecureString, PasswordOptions)

Sets the password on the specified object

Task SetPasswordAsync(CSEntry csentry, SecureString newPassword, PasswordOptions options)

Parameters

csentry CSEntry The CSEntry representing the object whose password should be set

newPassword SecureString The new password

options PasswordOptions Flags that indicate additional steps that may need to be taken once the password it set

Returns

Task A task that represents the asynchronous operation

ChangePasswordAsync(CSEntry, SecureString, SecureString)

Changes the password on the specified object

Task ChangePasswordAsync(CSEntry csentry, SecureString oldPassword, SecureString newPassword)

Parameters

csentry CSEntry The CSEntry representing the object whose password should be changed

oldPassword SecureString The old password

newPassword SecureString The new password

Returns

Task A task that represents the asynchronous operation