Show / Hide Table of Contents

Class Constants.Capabilities

String constants for document plugin capability names

Inheritance
Object
Constants.Capabilities
Inherited Members
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Documents
Assembly: SuperOffice.Plugins.dll
Syntax
public static class Capabilities

Fields

CanCreateDocumentTemplates

Can the document plugin create new document templates.

Declaration
public const string CanCreateDocumentTemplates = "can-create-document-templates"
Field Value
Type Description
String

FastExists

Does the plugin support efficient querying of document existence? Values are False and True

Declaration
public const string FastExists = "fast-exists"
Field Value
Type Description
String

FastLockStatus

Does the plugin support efficient querying of checkout status? Values are False and True

Declaration
public const string FastLockStatus = "fast-lock-status"
Field Value
Type Description
String

FastVersionList

Does the plugin support efficient querying of the version list for a document? Values are False and True

Declaration
public const string FastVersionList = "fast-version-list"
Field Value
Type Description
String

Locking

Does the plugin support locking? Values are False, Optional and Mandatory.

False implies that the feature is available. Optional implies that it is available and can be enabled or disabled on a per-document basis. Mandatory implies that all documents will have locking and that this feature cannot be disabled.

Declaration
public const string Locking = "locking"
Field Value
Type Description
String

MaxDocumentSize

Maximum supported document content size. Value should be parseable as an integer in the InvariantCulture, specifying number of bytes.

Declaration
public const string MaxDocumentSize = "max-document-size"
Field Value
Type Description
String

Timeout

General timeout value. NetServer may abandon document plugin calls if this value is exceeded. Value should be parseable as an integer in the InvariantCulture, specifying number of seconds.

Declaration
public const string Timeout = "timeout"
Field Value
Type Description
String

Versioning

Does the plugin support versioning? Versioning support also implies locking support. Values are False, Optional and Mandatory.

False implies that the feature is available. Optional implies that it is available and can be enabled or disabled on a per-document basis. Mandatory implies that all documents will have locking and that this feature cannot be disabled.

Declaration
public const string Versioning = "versioning"
Field Value
Type Description
String
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top