Class DWWebUrlLoginParameters

Class reperenting the parameters used for web login.

Inheritance

System.Object

DWWebUrlLoginParameters

DWIntegrationUrlParameters

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: DocuWare.WebIntegration

Assembly: DocuWare.WebIntegration.dll

Syntax

public class DWWebUrlLoginParameters

Constructors

DWWebUrlLoginParameters()

Initializes a new instance of the DWWebUrlLoginParameters class.

Declaration

public DWWebUrlLoginParameters()

Properties

AddNoise

Gets or sets wether to use noice param.

Declaration

public bool AddNoise { get; set; }

Property Value

Type	Description
System.Boolean

Culture

Gets or sets the culture which will be used to parse the url.

Declaration

public CultureInfo Culture { get; set; }

Property Value

Type	Description
System.Globalization.CultureInfo

LoginToken

Gets or sets the login token.

Declaration

public string LoginToken { get; set; }

Property Value

Type	Description
System.String

UserCredentials

Gets or sets the user credentials.

Declaration

public UserCredentials UserCredentials { get; set; }

Property Value

Type	Description
UserCredentials

UserKey

Gets or sets the user key.

Declaration

public string UserKey { get; set; }

Property Value

Type	Description
System.String

ValidFrom

Gets or sets the date from which the url integration should be valid.

Declaration

public DateTime? ValidFrom { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

ValidUntil

Gets or sets the date till which the url integration should be valid.

Declaration

public DateTime? ValidUntil { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

Version

Gets or sets the url version.

Declaration

public int Version { get; set; }

Property Value

Type	Description
System.Int32

Methods

GetEncryptableParams()

Returs a list with all the parameters which might be encrypted.

Declaration

protected virtual List<string> GetEncryptableParams()

Returns

Type	Description
System.Collections.Generic.List<System.String>	List with all the parameters which might be encrypted.

Parse(String)

Tries to create a DWWebUrlLoginParameters object by parsing the passed Url string.

Declaration

public static DWWebUrlLoginParameters Parse(string urlParamString)

Parameters

Type	Name	Description
System.String	urlParamString	The string to parse

Returns

Type	Description
DWWebUrlLoginParameters	A new instance of the DWWebUrlLoginParameters class.

SeparateParams(String)

Declaration

public static Dictionary<string, string> SeparateParams(string queryString)

Parameters

Type	Name	Description
System.String	queryString

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>

SetIntegrationParams(String, String)

Sets the value of a parameter.

Declaration

protected virtual bool SetIntegrationParams(string paramID, string value)

Parameters

Type	Name	Description
System.String	paramID	The id of the parameter.
System.String	value	The value of the parameter

Returns

Type	Description
System.Boolean	Returs true if successfull or false if there is no parameter with such id.