Document¶

Represents a document instance in a document archive.

Capabilities¶

Security and Profile¶

• Document.Acl: Gets or sets the Access Control List (ACL) of the document.
• Document.Profile: Gets the profile data of the document.
• Document.AddProfile: Adds profile data to the document.
• Document.SetSecurityProfile: Updates the security profile of the document.

Metadata¶

• Document.BranchId: Gets the branch ID of a document.
• Document.ContentType: Gets or sets the content type of the document.
• Document.CreatedAt: Gets the creation date and time of the document.
• Document.Description: Gets or sets the description of the document.
• Document.Id: Gets the globally unique identifier of the document.
• Document.IsReadonly: Gets a boolean value that specifies whether the document is currently read-only.
• Document.State: Gets the state of the document.
• Document.Title: Gets or sets the title of the document.
• Document.Version: Gets or sets the version number of the document.

Properties¶

• Document.CreatedBy: Gets or sets the user who created the document.

File Content¶

• Document.Files: Gets the collection of attached files for the document.

Lifecycle¶

• Document.Archive: Archives the document and returns the current document instance.
• Document.Delete: Deletes the document.
• Document.Publish: Publishes the document to the specified folders and returns the current document instance.
• Document.Save: Saves the changes to the document and returns the current document instance.
• Document.Unpublish: Unpublishes the document from all previously published folders and returns the current document instance.