Relativity.OutsideIn 2023.4.0

API Differences between 2023.4.0 and 2022.3.0

136 Additions 21 Removals

OILink

public enum ExporterType
- Local = 0
- Remote = 1
public interface IOILinkConfiguration : IEquatable<IOILinkConfiguration>
- ExporterType ExpType { get; }
- int ProcessMemoryLimit { get; set; }
public class OILink : IOILink, IProcessOwner
- public bool CanHandleCumulativeSet { get; }
- public OILink(IAuthenticate UserAuthenticationInfo)
- public static IOILinkStatus init(DirectoryInfo OILinkDir, IAuthenticate UserAuthenticationInfo)
- public static IOILinkStatus init(DirectoryInfo OILinkDir, uint WorkerProcessTimeOut, IAuthenticate UserAuthenticationInfo)
- public OILink(IOILinkConfiguration Config)
- public static IOILinkStatus init(DirectoryInfo OILinkDir, IOILinkConfiguration Config)
- public static IOILinkStatus init(DirectoryInfo OILinkDir, uint WorkerProcessTimeOut, IOILinkConfiguration Config)
- public Task EXCloseExportAsync(IOIHandle hexport)
- public IOIHandle EXOpenExport(IOIHandle hdoc, int outputFormat, FileInfo sink, IOILinkCallback callback)
- public IOIHandle EXOpenExport(IOIHandle hdoc, int outputFormat, IBasicIO sink, IOILinkCallback callback, bool IsUsingStreams)
- public IOIHandle EXOpenExport(IOIHandle hdoc, IFileFormat outputFormat, FileInfo sink, IOILinkCallback callback)
- public IOIHandle EXOpenExport(IOIHandle hdoc, IFileFormat outputFormat, IBasicIO sink, IOILinkCallback callback, bool IsUsingStreams)
- public void SetCumulativeOptions(string jsonOptions)
- public void SetMetricsDict(Dictionary<string, object> metrics)
- public void SetMetricsDict(MetricsCollector MetricsHandler, bool GenerateHash)
public static class OILinkConfigurationConstants
- public const int DEFAULT_PROCESS_MEM_LIMIT = 1024
- public const int MINIMUM_PROCESS_MEM_LIMIT = 200
public class OILinkMonitor : IOILinkMonitor
- public static void addProcessOwner(IProcessOwner owner, IAuthenticate authentication)
- public static void addProcessOwner(IProcessOwner owner, IOILinkConfiguration configuration)
- public static IProcessOwner getProcessOwner(IAuthenticate authentication)
- public static IProcessOwner getProcessOwner(IOILinkConfiguration config)
- public static void Pulse()
- public static void Pulse(Thread currThread = null)
- public static void setQueueTimeout(Thread currThread, long queueTimeout)
- public void setQueueTimeoutImpl(Thread currThread, long queueTimeout)
public class OILinkQueueTimeOutException : OILinkTimeOutException
- public OILinkQueueTimeOutException(TimeSpan ts)
- public OILinkQueueTimeOutException(TimeSpan ts, Exception ex)
- protected OILinkQueueTimeOutException(SerializationInfo info, StreamingContext context)
public class OILinkSccErr
- public static OILinkSccErr H5PIPELINECONVERSIONERROR
- public static OILinkSccErr H5PIPELINECONVERSIONERROR1
- public static OILinkSccErr SUSPICIOUSFILE
- public static OILinkSccErr TESTONLYFEATURE
public enum TMIStatus
- QueueTimedOut = 3

OILink.API

public interface IOILink : IProcessOwner
- bool CanHandleCumulativeSet { get; }
- int NativeProcessId { get; }
- Task EXCloseExportAsync(IOIHandle hexport)
- IOIHandle EXOpenExport(IOIHandle hdoc, int outputFormat, IBasicIO sink, IOILinkCallback callback, bool IsUsingStreams)
- IOIHandle EXOpenExport(IOIHandle hdoc, int outputFormat, FileInfo sink, IOILinkCallback callback)
- IOIHandle EXOpenExport(IOIHandle hdoc, IFileFormat outputFormat, IBasicIO sink, IOILinkCallback callback, bool IsUsingStreams)
- IOIHandle EXOpenExport(IOIHandle hdoc, IFileFormat outputFormat, FileInfo sink, IOILinkCallback callback)
- void SetCumulativeOptions(string jsonOptions)
- void SetMetricsDict(Dictionary<string, object> metrics)
- void SetMetricsDict(MetricsCollector MetricsHandler, bool GenerateHash)

OutsideIn

public interface Document : OptionsCache, IAnnotatable
- ExporterType ExpType { get; }
public interface Exporter : Document, OptionsCache, IAnnotatable, IDisposable
- int TestingMaxOILinkAge { get; set; }
- Task ExportAsync()
- int GetTestingMaxOILinkAge()
- OptionsCache SetTestingMaxOILinkAge(int maxOILinkAge)
public class FileFormat : IFileFormat
- public static FileFormat FI_PASSWORDJSON
- public FileFormat(int id, string description)
- public FileFormat(int id, string description, string extension = null, string mimetype = null)
- public static IFileFormat GetFileFormatFromMimeType(string mimetype)
- public string GetMimeType()
- public string GetRecommendedExtension()
public static class MetricKeysData
- public enum OIMetricElements
- public static readonly Dictionary<OIMetricElements, string> ElementNames
- public const string METRIC_APPLICATION_NAME = "application.name"
- public const string METRIC_CHARACTER_COUNT = "character_count"
- public const string METRIC_CONVERSION_GUID = "oi.conversion_guid"
- public const string METRIC_ERRORVALUE = "errorvalue"
- public const string METRIC_EXPORT_CONVERSION_TIME = "oi.export.conversion_time"
- public const string METRIC_EXPORT_STATUS_FLAGS = "oi.export.status_flags"
- public const string METRIC_EXPORT_SUBDOCS_FAILED = "oi.export.subdocs_failed"
- public const string METRIC_EXPORT_SUBDOCS_PASSED = "oi.export.subdocs_passed"
- public const string METRIC_FILE_INPUT_SIZE = "oi.input.file_size"
- public const string METRIC_FILE_OUTPUT_SIZE = "file.output_size"
- public const string METRIC_FILENAME = "oi.file.name"
- public const string METRIC_INPUT_FILEID = "oi.file_id"
- public const string METRIC_INPUT_FILETYPE = "file.type"
- public const string METRIC_INPUTBYTES_READ = "oi.input.bytes_read"
- public const string METRIC_MESSAGE = "message"
- public const string METRIC_NUM_DOCUMENTS_WRITTEN = "documents.written"
- public const string METRIC_NUM_ZEROBYTE_FILES = "oi.zero_byte_files_count"
- public const string METRIC_OIRE_THREAD_ID = "oi.oire_thread_id"
- public const string METRIC_OUTPUT_FILEID = "file.output_id"
- public const string METRIC_OUTPUT_HASH = "oi.output_hash"
- public const string METRIC_PAGE_COUNT = "oi.page_count"
- public const string METRIC_PASSWORD_BANKSIZE = "oi.password.bank_size"
- public const string METRIC_PASSWORD_INDEX = "oi.password.index"
- public const string METRIC_PDF_TYPE3_TEXT_COUNT = "type3_text_count"
- public const string METRIC_PROCESS_AGE = "oi.oilink.age"
- public const string METRIC_PROCESS_EXIT_CODE = "process.exit_code"
- public const string METRIC_PROCESS_MEMLIMIT = "oi.process.memlimit"
- public const string METRIC_PROCESS_PID = "process.pid"
- public const string METRIC_SERVICE_VERSION = "service.version"
- public const string METRIC_THREAD_ID = "thread_id"
public class MetricsCollector
- public Dictionary<string, object> AdditionalMetrics { get; }
- public Dictionary<string, object> Metrics { get; }
- public MetricsCollector()
- public MetricsCollector(string rawData)
- public string GetOIMetricsAsJson()
- public bool HasMetric(OIMetricElements element)
- public bool HasMetric(string keyname)
- public MetricsCollector SetMetric(OIMetricElements element, object value)
- public MetricsCollector SetMetric(string keyname, object value)
- public bool TryGetMetricValue(OIMetricElements element, out object value, bool CheckAdditionalMetrics = false)
- public bool TryGetMetricValue(OIMetricElements element, out int value, bool CheckAdditionalMetrics = false)
- public bool TryGetMetricValue(OIMetricElements element, out string value, bool CheckAdditionalMetrics = false)
- public void UpdateMetrics(MetricsCollector SourceCollector)
public class OutsideInException : Exception
- public OutsideInException(string errDesc, OILinkSccErr err)
public class OutsideInSuspiciousFileException : OutsideInException
- public OutsideInSuspiciousFileException(Exception ex)
- protected OutsideInSuspiciousFileException(SerializationInfo info, StreamingContext context)
public class OutsideInTestOnlyFeatureException : OutsideInException
- public OutsideInTestOnlyFeatureException(string optname)
- protected OutsideInTestOnlyFeatureException(SerializationInfo info, StreamingContext context)
public class OutsideInVersion
- public string GetExtendedVersion()
public class ShortDateFormat
- public ShortDateFormat()

OutsideIn.Common.Interface

public interface IFileFormat
- string GetDescription()
- int GetId()
- string GetMimeType()
- string GetRecommendedExtension()
public interface IProcessOwner
- int NativeProcessId { get; }

OutsideIn.Options

public class FontAliases : IFontAliases
- public FontAliases()
public class FontList : IFontList
- public FontList()
public class MarginText
- public Dictionary<Location, string> TextList
- public Dictionary<Location, string> TextList { get; set; }
- public MarginText()
public class Options : OptionImpl
- public class OptCJKUnifiedPreference : Options
- public static OptCJKUnifiedPreference CJKUnifiedPreference
public interface OptionsCache
- string ApplicationName { get; set; }
- string CJKUnifiedPreference { get; set; }
- bool CreatePasswordFile { get; set; }
- bool GenerateOutputHashMetric { get; set; }
- bool LimitOutput { get; set; }
- int ProcessMemoryLimit { get; set; }
- string GetAllOptionsAsJson()
- string GetCJKUnifiedPreference()
- bool GetCreatePasswordFile()
- FileFormat GetDestinationFormat()
- IFileFormat GetDestinationFormat()
- string GetOptionsAsJsonValueString()
- OptionsCache SetAllowedURLs(List<string> Urls)
- OptionsCache SetCJKUnifiedPreference(string CJKUnifiedPreference)
- OptionsCache SetCreatePasswordFile(bool createPasswordFile)
- OptionsCache SetDestinationFormat(IFileFormat fileId)
- OptionsCache SetOptions(string jsonOptionsString)
- OptionsCache SetOptions(string jsonPayload, string tagOptionsName)
- OptionsCache SetOptions(Dictionary<string, object> optionsList)
- OptionsCache SetSourceFormat(FileFormat fileId)
- OptionsCache SetSourceFormat(IFileFormat fileId)
- OptionsCache SetTestToggles(Dictionary<string, bool> Toggles)
public class PageInfo
- public PageInfo()
public enum SpecialOptionsValue
- ExportTimeoutOption = 2097152
- KeyValuePairsOption = 4194304
- PasswordsOption = 524288
- PulseTimeoutOption = 268435456