374 lines
15 KiB
XML
374 lines
15 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>
|
|
DigitalData.Modules.Windream
|
|
</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:DigitalData.Modules.Windream.My.Resources.Resources">
|
|
<summary>
|
|
Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DigitalData.Modules.Windream.My.Resources.Resources.ResourceManager">
|
|
<summary>
|
|
Gibt die zwischengespeicherte ResourceManager-Instanz zurück, die von dieser Klasse verwendet wird.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DigitalData.Modules.Windream.My.Resources.Resources.Culture">
|
|
<summary>
|
|
Überschreibt die CurrentUICulture-Eigenschaft des aktuellen Threads für alle
|
|
Ressourcenzuordnungen, die diese stark typisierte Ressourcenklasse verwenden.
|
|
</summary>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithSessionReconnect">
|
|
<summary>
|
|
Sets flag in Windream class to reconnect on lost connection
|
|
</summary>
|
|
<returns>A IConnectionBuilder instance to allow for chaining</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithDriveLetter(System.String)">
|
|
<summary>
|
|
Sets the drive letter of windream drive, default is "W"
|
|
</summary>
|
|
<param name="driveLetter">The drive letter to use</param>
|
|
<returns>A IConnectionBuilder instance to allow for chaining</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithWindreamObjects(System.String)">
|
|
<summary>
|
|
Sets the drive letter to String.Empty, use \\windream\objects as Windream base path
|
|
</summary>
|
|
<param name="BasePath">The windream base path, eg. \\windream\objects</param>
|
|
<returns>A IConnectionBuilder instance to allow for chaining</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithWindreamObjects">
|
|
<summary>
|
|
Sets the drive letter to String.Empty, use \\windream\objects as Windream base path
|
|
</summary>
|
|
<returns>A IConnectionBuilder instance to allow for chaining</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.With64BitSupport">
|
|
<summary>
|
|
Sets flag in Windream class to indicate 64-bit support
|
|
</summary>
|
|
<returns>A IConnectionBuilder instance to allow for chaining</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithServerName(System.String)">
|
|
<summary>
|
|
Sets the servername in Windream class, overriding the client setting
|
|
</summary>
|
|
<param name="serverName"></param>
|
|
<returns>A IConnectionBuilder instance to allow for chaining</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithImpersonation(System.String,System.String,System.String)">
|
|
<summary>
|
|
Sets the username, password and domain in Windream class, overriding the client settings
|
|
</summary>
|
|
<param name="userName">The username used for the connection</param>
|
|
<param name="password">The password used for the connection</param>
|
|
<param name="domain">The domain used for the connection</param>
|
|
<returns>A IConnectionBuilder instance to allow for chaining</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.Connect">
|
|
<summary>
|
|
Creates a connection.
|
|
</summary>
|
|
<exception cref="T:DigitalData.Modules.Windream.Exceptions.SessionException">If there was an error while establishing the connection</exception>
|
|
<returns>A Windream Object</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.#ctor(System.String,System.Boolean,System.Boolean,System.String,System.String,System.String,System.String)">
|
|
<summary>
|
|
Initializes windream and creates a windream session with the actual user
|
|
</summary>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.GetObjecttypeNames">
|
|
<summary>
|
|
Returns all Objecttypes of current server as list of strings
|
|
</summary>
|
|
<returns>List of String of all objecttypes</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.NewFolder(System.String)">
|
|
<summary>
|
|
Creates a folder in windream. All folder-parts will be checked
|
|
</summary>
|
|
<param name="folderpath">full path of new folder</param>
|
|
<returns>Returns true when folder was created, false if not</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.NewIndexFile(System.String,System.String,System.String[])">
|
|
<summary>
|
|
Indexes the file with the given values
|
|
</summary>
|
|
<param name="WMFile">full filepath</param>
|
|
<param name="indexname">Name of the index</param>
|
|
<param name="aValues">values as array</param>
|
|
<returns>Returns true when folder was created, false if not</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.NewObjecttypeForFolder(System.String,System.String)">
|
|
<summary>
|
|
Sets the folder-objecttype.
|
|
</summary>
|
|
<param name="folderpath">full path of folder</param>
|
|
<param name="folderObjecttype">Obcjectype Name</param>
|
|
<returns>Returns true when Otype was set, false if not</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.NewVersion(System.String,System.String)">
|
|
<summary>
|
|
Creates a new version of the file
|
|
</summary>
|
|
<param name="WMPath">full path to the file</param>
|
|
<param name="Comment">Comment</param>
|
|
<returns>Returns true when version was created, false if not</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.GetChoiceLists">
|
|
<summary>
|
|
Returns all choicelists
|
|
</summary>
|
|
<returns>Choicelists as List of Strings or empty list if no choice lists are found</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.GetIndicesByObjecttype(System.String)">
|
|
<summary>
|
|
Returns all indices for an objecttype
|
|
</summary>
|
|
<param name="ObjecttypeName">Name of objecttype</param>
|
|
<returns>Names of indices as list of String</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.GetChoicelistItems(System.String)">
|
|
<summary>
|
|
Returns all items of a choicelist
|
|
</summary>
|
|
<param name="NameChoicelist">name of choicelist</param>
|
|
<returns>Items as list of String</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.GetSearchDocuments(System.String,System.String)">
|
|
<summary>
|
|
Returns the result of windream-search
|
|
</summary>
|
|
<param name="wdfLocation">filepath of windreamSearch-file</param>
|
|
<param name="NameIndexDocID">Name of the Docid Index </param>
|
|
<returns>Returns datatable</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.GetTypeOfIndexAsInt(System.String)">
|
|
<summary>
|
|
Returns a windream-type as Integer.
|
|
</summary>
|
|
<param name="indexname">Name of indexfield</param>
|
|
<returns>Returns integer, which describes the type</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.GetValueforIndex(System.String,System.String)">
|
|
<summary>
|
|
Returns the value(s) for an index as a datatable
|
|
</summary>
|
|
<param name="WMFile">filepath of windream-file</param>
|
|
<param name="NameIndex">Name of the index </param>
|
|
<returns>Datatable</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.Return_VektorArray(WINDREAMLib.WMObject,System.String,System.Object,System.Object)">
|
|
<summary>
|
|
Returns the values for a vektorfield plus the new ones
|
|
</summary>
|
|
<param name="oDocument">windream-file as Object</param>
|
|
<param name="vktIndexName">Name of the index </param>
|
|
<returns>Returns value as Datatable</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.GetWMObjectForFile(System.String)">
|
|
<summary>
|
|
Returns a WMObject if file exists
|
|
</summary>
|
|
<param name="WMPath">full path to the file</param>
|
|
<returns>Returns WMObject</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.TestFolderExists(System.String)">
|
|
<summary>
|
|
Checks if the folder exists
|
|
</summary>
|
|
<param name="folderpath">The path of the folder</param>
|
|
<returns>True if exists or false if not or error occured</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.TestWMFileExists(System.String)">
|
|
<summary>
|
|
Checks wether file exists in windream
|
|
</summary>
|
|
<param name="WMPath">full path to the file</param>
|
|
<returns>Returns true when file was deleted, false if not</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.TestWMUSerExists(System.String)">
|
|
<summary>
|
|
Checks if user exists in windream.
|
|
</summary>
|
|
<param name="username">test username</param>
|
|
<returns>Returns true if exists, false if not</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.TestWMGroupExists(System.String)">
|
|
<summary>
|
|
Checks if group exists in windream.
|
|
</summary>
|
|
<param name="groupname">test username</param>
|
|
<returns>Returns true if exists, false if not</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.RemFile(System.String)">
|
|
<summary>
|
|
Deletes a file in windream including all preversions
|
|
</summary>
|
|
<param name="WMPath">full path to the file</param>
|
|
<returns>Returns true when file was deleted, false if not</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream_alt.REMOVE_VEKTOR_LINK(System.String,System.String,System.String)">
|
|
<summary>
|
|
Removes the vektorlink from windream
|
|
</summary>
|
|
<param name="WMPath">full path to the file</param>
|
|
<param name="vktIndexName">Indexname of Vektor-Index</param>
|
|
<param name="deleteValue">Value which is to be deleted</param>
|
|
<returns>Returns true when indexing was successfull, false if not</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="T:DigitalData.Modules.Windream.Windream">
|
|
<module>Windream</module>
|
|
<version>0.0.0.2</version>
|
|
<date>23.10.2018</date>
|
|
<summary>
|
|
Module that provides methods to access the Windream ECM
|
|
</summary>
|
|
<dependencies>
|
|
NLog, >= 4.5.8
|
|
</dependencies>
|
|
<params>
|
|
LogConfig, DigitalData.Modules.Logging.LogConfig
|
|
The LogFactory containing the current log config. Used to instanciate the class logger for this and any dependent class
|
|
|
|
ClientDriveLetter, String
|
|
Drive Letter of the Windream Drive, should default to `W`
|
|
|
|
ClientSupport64Bit, Boolean
|
|
Should this session support 64bit methods/functionality?
|
|
|
|
SessionReconnect, Boolean
|
|
Should the session reconnect automatically when the connection to the server is lost?
|
|
|
|
SessionServerName, String
|
|
Name of the server used in the connection. If this is `Nothing`, the current server defined in the client is used
|
|
|
|
SessionUserName, String
|
|
Name of the user that is used in the connection. If this is `Nothing`, the currently signed in user is used
|
|
|
|
SessionPassword, String
|
|
User-password that is used in the connection. If this is `Nothing`, the currently signed in user is used
|
|
|
|
SessionDomain, String
|
|
User-domain that is used in the connection. If this is `Nothing`, the currently signed in user is used
|
|
</params>
|
|
<props>
|
|
ClientDriveLetter, String (readonly)
|
|
ClientSupports64Bit, Boolean (readonly)
|
|
Session, IWMSession2 (readonly)
|
|
SessionLoggedin, Boolean (readonly)
|
|
SessionReconnect, Boolean (readonly)
|
|
SessionServername, String (readonly)
|
|
Objecttypes, List(Of String) (readonly)
|
|
</props>
|
|
<example>
|
|
_windream = New ConnectionBuilder(LogConfig).
|
|
WithDriveLetter("W").
|
|
WithSessionReconnect().
|
|
With64BitSupport().
|
|
WithServerName("sdd-vmx02-aps01").
|
|
Connect()
|
|
</example>
|
|
<remarks>
|
|
This class should not be instanciated directly. Instead, ConnectionBuilder should be used.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:DigitalData.Modules.Windream.Windream.ObjectTypes">
|
|
<returns>A list of object types that are available</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream.#ctor(DigitalData.Modules.Logging.LogConfig,System.Boolean,System.String,System.String,System.Boolean,System.String,System.String,System.String,System.String)">
|
|
<summary>
|
|
Creates a new Windream object and connects to a server with the provided options and credentials
|
|
</summary>
|
|
<param name="LogConfig"></param>
|
|
<param name="SessionReconnect"></param>
|
|
<param name="ClientDriveLetter"></param>
|
|
<param name="ClientSupport64Bit"></param>
|
|
<param name="SessionServerName"></param>
|
|
<param name="SessionUserName"></param>
|
|
<param name="SessionPassword"></param>
|
|
<param name="SessionDomain"></param>
|
|
<exception cref="T:DigitalData.Modules.Windream.Exceptions.SessionException"></exception>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream.NewLifecycle_Period(System.String,System.DateTime,System.Double,System.String)">
|
|
<summary>
|
|
changes the archive end date
|
|
</summary>
|
|
<param name="wmfilepath">WM Filepath</param>
|
|
<param name="date_period">number/count of period (if </param>
|
|
<param name="date_unit">date_unity (d,m,y or day(s),month(s),years(s)</param>
|
|
<param name="dateFrom_value">dateFrom_value</param>
|
|
<returns>Returns true when date was set, false if not</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream.NewLifecycle_PeriodTEST(System.String,System.String)">
|
|
<summary>
|
|
changes the archive end date
|
|
</summary>
|
|
<param name="wmfilepath">WM Filepath</param>
|
|
<param name="date_period">number/count of period (if </param>
|
|
<param name="date_unit">date_unity (d,m,y or day(s),month(s),years(s)</param>
|
|
<param name="dateFrom_value">dateFrom_value</param>
|
|
<returns>Returns true when date was set, false if not</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream.SetArchive_Active(WINDREAMLib.WMObject)">
|
|
<summary>
|
|
Archives windream object immediately
|
|
</summary>
|
|
<returns>Returns true when archiving was set, false if not</returns>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream.GetSearchDocuments(System.String,System.String)">
|
|
<summary>
|
|
Returns the result of a search file
|
|
</summary>
|
|
<param name="SearchFilePath">Path of a search file (*.wdf)</param>
|
|
<param name="DocIdIndexName">Index containing the Document-ID</param>
|
|
<returns>A datatable of the results with columns PATH and DOCID</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream.GetVektorData_Combined(WINDREAMLib.WMObject,System.String,System.Object,System.Boolean)">
|
|
<summary>
|
|
Gets an array of the actual vektorvalues of index, collated with the passed values
|
|
</summary>
|
|
<param name="WindreamObject">windream-file as WMObject</param>
|
|
<param name="IndexName">Indexname as String</param>
|
|
<param name="NewValues">The new values as Array</param>
|
|
<param name="CheckDuplikat">True if duplicates shall be prevented</param>
|
|
<exception cref="T:DigitalData.Modules.Windream.Exceptions.SessionException"></exception>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Windream.Windream.SetFolderObjecttype(System.String,System.String)">
|
|
<summary>
|
|
Sets objecttype of a folder
|
|
</summary>
|
|
<param name="FolderPath"></param>
|
|
<param name="Objecttype"></param>
|
|
<returns></returns>
|
|
</member>
|
|
</members>
|
|
</doc>
|