IDocumentHistoryItem

class IDocumentHistoryItem

Bases: ImpactCOMWrapperBase

Description:

Represents an operation performed on a document.

Remarks:

All operations performed by a user or through COM on a document create a document history item.

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property application

Gets Application.

Description:

The application that performed the document operation.

Remarks:

Introduced in Impact 9.0.0.83.

Returns:

The value of Application.

Return type:

application (str)

property can_edit_details

Gets can_edit_details.

Description:

Determines if the Details property can be set.

Remarks:

Introduced in Impact 9.0.0.83.

Returns:

The value of can_edit_details.

Return type:

can_edit_details (bool)

property details

Gets Details.

Description:

Additional details for the operation.

Remarks:

Check can_edit_details to determine if you can set this property for this history item.

Returns:

The value of Details.

Return type:

details (str)

property document

Gets Document.

Description:

Gets the IDocument that this history item belongs to.

Remarks:

Introduced in Impact 9.0.0.83.

Returns:

The value of Document.

Return type:

document (IDocument)

property modified_by

Gets modified_by.

Description:

The user that performed the operation on this document.

Returns:

The value of modified_by.

Return type:

modified_by (IUser)

property modified_date_time

Gets modified_date_time.

Description:

The date and time that this operation was performed.

Returns:

The value of modified_date_time.

Return type:

modified_date_time (datetime)

property operation

Gets Operation.

Description:

The operation peformed on the document.

Remarks:

This method has been deprecated. You should use operation_as_string instead. The values returned by Operation may fall outside the ipDocumentHistoryOperation values. The ipDocumentHistoryOperation values may be returned for existing pre Impact 2015 document history operations but are no longer used.

Returns:

The value of Operation.

Return type:

operation (ipDocumentHistoryOperation)

property operation_as_string

Gets operation_as_string.

Description:

The operation as a string that was peformed on the document.

Remarks:

Introduced in Impact 9.0.0.83.

Returns:

The value of operation_as_string.

Return type:

operation_as_string (str)

property version

Gets Version.

Description:

An optional version for the history item.

Remarks:

Introduced in Impact 9.0.0.83.

Returns:

The value of Version.

Return type:

version (str)