Enum Reference

Below is an alphabetical reference for the enums used in the API.

ADAuthManagerLogonAttribute (v6.3 and later)

Used in the ICIADAuthManagerSettings LogonAttribute property.

ADAuthManagerType (v6.3 and later)

Used in the ICIADAuthManagerSettings type property.

AdminAccountType (v6.1 and later)

Used to specify the type of EFT administrator account in the ICIAdminAccount type property, and the ICIServer CreateAdmin, CreateAdminID, and RemoveServerAdminAccount methods.

AdminLoginType (v6.1 and later)

Used to specify the way an EFT administrator connects to the server in the ICIServer ConnectEx, GetBackupArchiveInfo, and RestoreServerConfigurationEx methods.

AdminPermissionsPolicy (v6.1 and later)

Used in the ICIAdminPermission Permission property.

ARMAuthenticationType (v6.3 and later)

Used in the ICIBackupArchiveInfo and ICIServer - Server Interface ARMAuthenticationType properties to specify the ARM database authentication type.

ARMDatabaseType (v6.3 and later)

Used in the ICIBackupArchiveInfo and ICIServer - Server Interface ARMDatabaseType properties to specify the ARM database type.

AS2AuthenticationType (v6.3 and later)

Used in the ICIAS2InboundSettings AuthenticationType property used to specify the AS2 authentication mechanism.

AS2ContentType (v6.1 and later)

Used to specify the type of the document to send in the ICIAS2OutboundSettings and ICIAS2SendActionParams ContentType properties.

AS2DoubleContentPolicy (v6.3 and later)

Used in the ICIAS2InboundSettings DoubleContentPolicy property to specify the AS2 duplicate contents policy.

AS2DoubleMsgIDPolicy (v6.3 and later)

Used in the ICIAS2InboundSettings DoubleMsgIDPolicy property to specify the AS2 duplicate message ID policy.

AS2EncryptionAlgorithm (v7.4.9 and later)

Used in the ICIAS2OutboundSettings EncryptionAlgorithm property to specify allowed encryption algorithms.

AS2EncryptMissingPolicy (v6.3 and later)

Used in the ICIAS2InboundSettings EncryptMissingPolicy property.

AS2IDMismatchPolicy (v6.3 and later)

Used in the ICIAS2InboundSettings EFTIDMismatchPolicy and PartnerIDMismatchPolicy properties to specify the mismatch policy.

AS2MICHash (v7.4.11 and later)

AS2OutboundProfileStatus (v6.3 and later)

Used in the ICIClientSettings AS2TestOutboundProfile method to retrieve the result for AS2 Test Outbound Profile operation.

 AS2ProxyType (v6.3 and later)

Used in the ICIAS2OutboundSettings ProxyType property to specify the AS2 proxy type.

AS2ReceiptDelivery (v6.1 and later)

Used to specify the receipt delivery mechanism in the ICIAS2OutboundSettings and ICIAS2SendActionParams ReceiptDelivery property.

AS2ReceiptPolicy (v6.1 and later)

Used to specify the type of the receipt required in the ICIAS2OutboundSettings and ICIAS2SendActionParams ReceiptPolicy property.

AS2SignatureAlgorithm (v7.4.9 and later)

The AS2SignatureAlgorithm enum is used in the ICIAS2OutboundSettings SignatureAlgorithm property.

AS2SignatureMissingPolicy (v6.3 and later)

Used in the ICIAS2InboundSettings SignatureMissingPolicy property to specify the AS2 signature-missing policy.

AS2TransactionDirection (v6.3 and later)

Used in the ICIAS2TransactionInfo Interface Direction property to retrieve the direction of an AS2 transaction.

AS2TransactionStatus (v6.3 and later)

Used in the ICIAS2TransactionInfo Interface Status property to retrieve the status of an AS2 transaction.

AutobanSensitivity (v6.1 and later)

Used to specify the sensitivity for Flood/Hammer Autoban settings in the ICISite Interface AutobanSensitivity property.

AWLogMode (v6.5 and later)

AWLogMode enumeration represents different Advanced Workflow debug logging modes (see also ICIAdvancedWorkflowParams::LogMode).

AWSS3AuthType (v7.4.6 and later)

Used in the ICICloudAWSS3GeneralParams interface.

AWSS3BucketAccessStyle (v7.4.6 and later)

AWSS3EncryptionType (v7.4.6 and later)

Used in the ICICloudAWSS3GeneralParams interface.

AWSS3MatchingFileNamePolicy (v7.4.6 and later)

Used in the ICICloudAWSS3UploadParams and ICICloudAWSS3DownloadParams interfaces.

AWSS3Region (v7.4.6 only; Refer to ICICloudAWSS3GeneralParams.Region property for v7.4.7 and later)

Used in the ICICloudAWSS3GeneralParams interface

AWSS3StorageClass (v7.4.6 and later)

Used in the ICICloudAWSS3GeneralParams interface.

AzureBlobAuthType (v7.4.6 and later)

Used in the ICICloudAzureBlobGeneralParams interface.

AzureBlobMatchingFileNamePolicy (v7.4.6 and later)

Used in the ICICloudAzureBlobUploadParams and ICICloudAzureBlobDownloadParams interfaces.

CaptchaType (v7.4.2 and later)

Used in the ICISite interface WorkspacesDropOffCaptchaType property to specify the type of CAPTCHA to use.

CertificateFormat (v6.3 and later)

Used in the ICIServer Interface CreateSSLCertificate method to specify the certificate and private key format.

CleanupTimestampType

CloudProviderType (v7.4.6 and later)

Used in the ICICloudTransferActionParams, ICIConnectionProfileParams, and ICICloudTransferActionParams interfaces.

CloudStorageMonitorScanIntervalUnitType (v7.4.6 and later)

CompressFormat (v7.2 and later)

Used in the ICICompressActionParams interface, Format property.

CompressMethod (v7.2 and later)

Used in the ICICompressActionParams interface, Method property.

CompressOperation (v7.2 and later)

Used in the ICICompressActionParams interface, Operation property.

CompressOverwritePolicy (v7.2 and later)

Used in the ICICompressActionParams interface, OverwritePolicy property.

ConditionOperator (v6.1 and later)

Used in the ICICompoundCondition Interface Add method, the ICIEventRule Interface AddIfStatement method, and the ICISimpleCondition Interface Operator property

ConnectionProfileType (v7.4.6 and later)

 Used in the ICIConnectionProfileParams interface.

DataSanitizationMethod (v6.3 and later)

Used in the ICISite Interface DataSanitizationMethod property to specify the data wiping technique.

DiagLoggingER (7.4 and later)

Used in the ICIServer interface, DiagLoggingER is used in the Event Rule transfer log.

EMailLoginCredentialsMode (v6.3 and later)

Used in the ICISite Interface EMailLoginCredentialsMode property used to specify how to e-mail users their login credentials.

ERChangeLog (v7.2 and later)

ERChangeLog is used in the ICIServer interface in the EventRuleChangeLog property. The Event Rule Change Log must be enabled on the Server before changes will appear in the Change Log.

EventActionType (v6.0 and later)

Used in the ICIEventAction Interface type property.

EventLogType (v6.3 and later)

Used in the ICIWindowsEventLogActionParams Interface type property to specify the event log type in the "Write to Windows Event Log" action.

EventProperty (v6.1 and later)

Used in the ICICompoundCondition Interface Add method, ICIEventRule Interface AddIfStatement method, and ICISimpleCondition Interface.

AS2 Properties:

Advanced Workflow Properties (7.4.7 and later):

Context Variable properties (v7.2 and later):

Data Types:

Client Properties:

Connection Properties:

File System Properties:

General Properties:

Server Properties:

Site Properties:

Transfer properties (v7.2.1 and later):

Workspace Properties

EventReason (v6.3 and later)

EventReason allows you to specify the reason for a triggered event. It is a value type for Event Conditions (e.g., If event reason is "transfer failed due to file is of banned type," do this; otherwise, do that for On Upload Failed Event Rule). It can also be used in condition values:

ICIEventRule.AddIfStatement (creating new IF statement with "If Event Reason is equal to XXX" condition: Event Property is "Reason," value is one of EventReason enum)

ICICompoundCondition.Add (adding "If Event Reason is equal to XXX" condition to existing IF statement: Event Property is "Reason," value is one of EventReason enum)

ICISimpleCondition.Value (retrieving/modifying "XXX" in existing "If Event Reason is equal to XXX" condition: value is one of EventReason enum).

EventRuleSchedulingAlgorithm (v7.0 and v7.0.1)

EventRuleStatementType (v6.0 and later)

Used in the ICIActionStatement Interface type property and the ICIIfStatement Interface type property.

EventType (v6.0 and later)

Used to specify the type of event trigger ICISite Interface EventRules method and the ICIEventInfo Interface and ICIEventRuleStatement Interface type properties.

FileEncodingType (v7.2 and later)

Used in the ICIFileActionParams Interface Encoding property.

FileOperationType (v7.2 and later)

Used in the ICIFileActionParams Interface Operation property.

FileOverwriteOptions (v7.2 and later)

Used in the ICIFileActionParams Interface OverwriteOption property.

FolderMonitorPollIntervalType (v6.5 and later)

Used to specify Folder Monitor polling by seconds, minutes, or hours.

FolderOperationType (v7.2 and later)

Used in the ICIFolderActionParams Interface Operation property.

FTPDataConnectionMode (v6.2.18 and later)

Used in the ICITransferActionParams Interface FTPDataConnectionMode property used to specify the mode of FTP data connection.

HADeploymentScenario

IcapMaxScanSizeUnits (v7.0.3 and later)

Used in the ICIContentIntegrityControlProfile interface MaxScanSizeUnits property.

ICAPMode (v7.0.3 and later)

Used in the ICIContentIntegrityControlProfile interface IcapMode property.

IPAccessRuleType (v6.3 and later)

Server.GetIPAccessRules, Site.GetIPAccessRules, and Client.GetIPAccessRules return the array of ICIIPAccessRule (which can be either Manual or Autoban); ICIAutobanIPAccesRule.BannedIPs is the array of ICIBannedIP. All are read-only properties; to modify IP Access, use the corresponding methods of Server, Site, or Client (Move, Remove, Unban, etc).

Example (VBScript):

rules = oServer.GetIPAccessRules()

For Each key In rules

If key.type = 0 Then

WScript.echo "AutoBan"

End if

If key.type = 1 Then

WScript.echo "Manual " + key.address

End if

Next

LDAPSearchScope (v6.3 and later)

Used in the ICILDAPAuthManagerSettings Interface SearchScope property.

LDAPVersion (v6.3 and later)

Used in the ICILDAPAuthManagerSettings Interface LDAPVersion property.

LogicalOperator (v6.1 and later)

Used in the ICICompoundCondition Interface Operator property.

LogMode (v6.3 and later)

Used in the ICIServer Interface LogMode property to specify the logging mode.

Month (v6.3 and later)

Used in the ICITimerEventRuleParams Interface YearlyMonth property.

NetworkProtocol (v6.1 and later)

Used in the ICITransferActionParams Interface Protocol property.

PGPCompressionLevel (v6.1 and later)

Used to specify the compression level for a PGP encryption operation in the ICIPgpActionParams Interface CompressionLevel property.

PGPKeyCipher (v6.3 and later)

Used in the ICIServer Interface CreatePGPKey method to specify the PGP key cipher.

PGPKeyType (v6.3 and later)

Used in the ICIServer Interface CreatePGPKey method to specify the PGP key type.

PGPLogLevel (v6.3 and later)

Used in the ICISite Interface PGPLogLevel property to specify the PGP module log level.

PGPOperation (v6.0 and later)

Used to specify the PGP operation to perform on a file in the ICIPgpActionParams Interface Operation property.

PGPSigningHash (v6.1 and later)

Used to specify the hash algorithm for a PGP signing operation in the ICIPgpActionParams Interface SigningHash property.

PredefinedReportPeriod (v6.1 and later)

Used to specify one of the predefined reporting periods in the ICIReportActionParams Interface CustomDate property.

PrePostTransferCommand (v7.1.1 and later)

Used in the TransferActionParams interface.

ProxyAuthenticationType (v6.2.31 and later)

Used in the ICITransferActionParams Interface ProxyAuthenticationType property used to specify the proxy authentication type.

ProxyType (v6.2.31 and later)

Used in the ICITransferActionParams Interface, ICIDownloadActionParams Interface, and ICIUploadActionParams Interface ProxyType property used to specify the type of Proxy.

Recurrence (v6.3 and later)

Used in the ICITimerEventRuleParams Interface Recurrence property.

RegistrationState (v6.1 and later)

Used in the ICIServer Interface ModuleRegistrationState method to retrieve EFT module registration status. Used with the ServerModule enumerators.

Relation (v6.3 and later)

Used in the ICITimerEventRuleParams Interface MonthlyRelativeWeekday and YearlyRelativeWeekday properties to specify the relation of one weekday to the month or year (e.g., first weekday of the month, last weekday of the year).

RepeatPattern (v6.3 and later)

Used in the ICITimerEventRuleParams Interface RepeatPattern property to specify a pattern for Timer Event Rules (e.g., repeats every hour, repeats every 30 minutes, etc.).

ReportFilterOperator (v6.1 and later)

Used to specify a report filter operator in the ICIReportActionParams Interface FilterOperator1 and FilterOperator2 properties.

ReportFiltersCombiningOperator (v6.1 and later)

Used to specify the way of combining two report filters in the ICIReportActionParams Interface FilterAndOr property.

ReportFormat (v6.1 and later)

Used to specify the report format in the ICIReportActionParams Interface ReportFileFormat property.

ReportPeriodType (v6.1 and later)

Used to specify a type of reporting period (range or predefined) in the ICIReportActionParams Interface DateFormat property.

ServerModule (v6.1 and later)

Used in the ICIServer Interface ModuleRegistrationState method to retrieve an EFT module state. Used with the RegistrationState enumerator.

ServerNodeSiteState (v7.2.1 and later)

Used for the ICIServerNodeSiteInfo Interface State property to specify state of cluster node.

SFTPAdvBool (v6.0 and later)

Used in numerous properties and methods. Difference between VARIANT_BOOL and SFTPAdvBool.

SizeUnits (v7.4.2 and later)

Used in the ICISite interface SetWorkspacesDropOffMaxMessageSize method.

SOCKSType (v6.2.31 and later)

Used in the ICIDownloadActionParams Interface Properties ICITransferActionParams Interface, and ICIUploadActionParams Interface SOCKSType property to specify the SOCKS proxy type for a transfer action.

StopType (v6.1 and later)

Used in the ICIStopActionParams Interface Action property.

SuppressForgotPasswordMode (v7.4.11 and later)

Allows you to suppress the ability for users to reset their password for all domains, only internal domains, or only external domains.

TimeUnits (v7.3.3 and later)

 The TimeUnits enum is used in the ICISite interface Get/SetWorkspacesMacDuration and Get/SetWorkspacesMacOAIDuration methods.

TransferEncodingType (v6.5 and later)

Allows you to specify transfer encoding mode. Used in the ICISite interface SFTPEncoding and FTPEncoding properties, and the ICITransferActionParams interface TransferEncoding property.

TransferOverwriteType (v6.2.31 and later)

Used in the ICIDownloadActionParams Interface, ICITransferActionParams Interface, and ICIUploadActionParams Interface OverwriteType property used to specify how to replace files that have the same names when transferring files.

TwoFactorAuthenticationMode (v6.3 and later)

Used in the ICISite Interface TwoFactorAuthentication property to specify special authentication mode for Site users.

UserAccountActionType (7.4.13 and later)

Used in ICIUserAccountActionParams to specify property action.

WebServiceVerbType (v7.2 and later)

Used in the ICIWebServiceActionParams interface Verb property.

WebSSONameOrAttribute (v7.3.3 and later)

WebSSONameOrAttributeIdentifierFormat (v7.3.3 and later)

Weekday (v6.3 and later)

Used in the ICITimerEventRuleParams Interface MonthlyWeekday and YearlyWeekday properties to specify the day of the week.

Weekdays (v6.1 - 6.2.31; replaced with Weekday, above)

Used in the ICITimerEventRuleParams Interface MonthlyWeekday and YearlyWeekday properties to specify the day of the week.

WorkspacesOAISharingModeType (v7.3.3 and later)

This enum is used in the ICISite interface WorkspacesOAISharingMode property.

WorkspacesParticipationlessAccountPolicy (v7.4.6 and later)

Used in the ICISite interface WorkspacesGAParticipationlessAccountPolicy property.

WorkspacesSecureMessageBodyPolicy (v7.4.6 and later)