com.groupdocs.search.events

Class PasswordRequiredEventArgs

java.lang.Object

com.groupdocs.search.events.EventArgs

com.groupdocs.search.events.BaseIndexEventArgs

com.groupdocs.search.events.PasswordRequiredEventArgs

public class PasswordRequiredEventArgs
extends BaseIndexEventArgs

Represents arguments for the event that occurs when document protected by a password is indexing.

Learn more

• Search index events

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PasswordRequiredEventArgs(com.aspose.ms.System.Guid indexId, String indexFolder, IndexStatus status, String filePath) Initializes a new instance of the PasswordRequiredEventArgs class.

Method Summary

Modifier and Type	Method and Description
protected static PasswordRequiredEventArgs	create(com.aspose.ms.System.Guid indexId, String indexFolder, IndexStatus status, String filePath)
String	getDocumentFullPath() Gets the document full path.
String	getPassword() Gets the password for opening the document.
void	setPassword(String value) Sets the password for opening the document.

Methods inherited from class com.groupdocs.search.events.BaseIndexEventArgs

create, getIndexFolder, getIndexId, getStatus, getTime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PasswordRequiredEventArgs

protected PasswordRequiredEventArgs(com.aspose.ms.System.Guid indexId,
                                    String indexFolder,
                                    IndexStatus status,
                                    String filePath)

Initializes a new instance of the PasswordRequiredEventArgs class.

Parameters:

indexId - The index ID.

indexFolder - The index folder.

status - The status.

filePath - The document file path.

Method Detail

create

protected static PasswordRequiredEventArgs create(com.aspose.ms.System.Guid indexId,
                                                  String indexFolder,
                                                  IndexStatus status,
                                                  String filePath)

getDocumentFullPath

public final String getDocumentFullPath()

Gets the document full path.

Returns:

The document full path.

getPassword

public final String getPassword()

Gets the password for opening the document.

Returns:

The password for opening the document.

setPassword

public final void setPassword(String value)

Sets the password for opening the document.

Parameters:

value - The password for opening the document.