Class DWIntegrationUrlParameters

Class reperenting the integration parameters.

Inheritance
System.Object
DWWebUrlLoginParameters
DWIntegrationUrlParameters
Inherited Members
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 DWIntegrationUrlParameters : DWWebUrlLoginParameters

Constructors

DWIntegrationUrlParameters(IntegrationType)

Initializes a new instance of the DWIntegrationUrlParameters class.

Declaration
public DWIntegrationUrlParameters(IntegrationType integrationType)
Parameters
Type Name Description
IntegrationType integrationType

The type of the integration.
Remarks

The integration id may be null then the standard hidden integration is used.

Properties

DialogValues

Used for the integration specifying the values with which the dialog will be filled.

Declaration
public string DialogValues { get; set; }
Property Value
Type Description
System.String
Remarks

The entire string must be Base64 url encoded and the values of the fields must be in the following format: "[FieldName1]=fieldValue1&[FieldName2]=fieldValue2" For NUMERIC or DATE field where any or both of the "from" and "to" values need to be filled they are separated with ; Example: [NUMERIC_FIELD]=1;5 fills both "from" and "to" values [NUMERIC_FIELD]=;5 fills only "to" value [NUMERIC_FIELD]=1 fills only "from" value For KEYWORD fields a list separated with ; must be used.

DisplayOneDoc

If set to true if the result list contains only one document a viewer integration will be shown with the document.

Declaration
public bool DisplayOneDoc { get; set; }
Property Value
Type Description
System.Boolean

DocId

Gets or sets the docID

Declaration
public string DocId { get; set; }
Property Value
Type Description
System.String

DocIdValues

DocIdValues is actually json string with the following format(without the new lines): { "fcid1": [array of doc ids], "fcid2": [array of doc ids], .... }

Declaration
public string DocIdValues { get; set; }
Property Value
Type Description
System.String

DocumentLinkGuid

Gets or sets the guid of the document link id .

Declaration
public Guid DocumentLinkGuid { get; set; }
Property Value
Type Description
System.Guid

DownloadType

Gets or sets the DownloadType.

Declaration
public DownloadType? DownloadType { get; set; }
Property Value
Type Description
System.Nullable<DownloadType>

FileCabinetGuid

Gets or sets the guid of the file cabinet.

Declaration
public Guid FileCabinetGuid { get; set; }
Property Value
Type Description
System.Guid

IntegrationType

Gets or sets the IntegrationType.

Declaration
public IntegrationType? IntegrationType { get; set; }
Property Value
Type Description
System.Nullable<IntegrationType>

Query

Gets or sets the query string.

Declaration
public string Query { get; set; }
Property Value
Type Description
System.String

QueryInInvariantCulture

Declaration
public bool QueryInInvariantCulture { get; set; }
Property Value
Type Description
System.Boolean

ResultListGuid

Gets or sets the guid of the result list.

Declaration
public Guid ResultListGuid { get; set; }
Property Value
Type Description
System.Guid

SearchDialogGuid

Gets or sets the search dialog guid.

Declaration
public Guid SearchDialogGuid { get; set; }
Property Value
Type Description
System.Guid

SectionId

Gets or sets the sectionID

Declaration
public string SectionId { get; set; }
Property Value
Type Description
System.String

SourceCabinetId

Declaration
public string SourceCabinetId { get; set; }
Property Value
Type Description
System.String

StoreDialogGuid

Declaration
public Guid StoreDialogGuid { get; set; }
Property Value
Type Description
System.Guid

ViewerWindowName

Gets or sets the viewer window name.

Declaration
public string ViewerWindowName { get; set; }
Property Value
Type Description
System.String

WaitForDocContent

Declaration
public bool WaitForDocContent { get; set; }
Property Value
Type Description
System.Boolean

WebBasketId

Gets or sets the guid of the web basket.

Declaration
public string WebBasketId { get; set; }
Property Value
Type Description
System.String

WorkflowId

Gets/Sets the workflow id.

Declaration
public Guid WorkflowId { get; set; }
Property Value
Type Description
System.Guid

WorkflowInstanceId

Gets/sets the workflow instance Id

Declaration
public Guid WorkflowInstanceId { get; set; }
Property Value
Type Description
System.Guid

WorkflowRoleType

The workflow role type.

Declaration
public WorkflowRoleType WorkflowRoleType { get; set; }
Property Value
Type Description
WorkflowRoleType

WorkflowTaskId

Gets/sets the workflow task Id

Declaration
public Guid WorkflowTaskId { get; set; }
Property Value
Type Description
System.Guid

Methods

FlattenDialogValue(DialogFieldValue)

Declaration
public static string FlattenDialogValue(DialogFieldValue dlgValue)
Parameters
Type Name Description
DialogFieldValue dlgValue
Returns
Type Description
System.String

GetDialogValues()

Gets the dialog values used in the integration as list of DialogFieldValue.

Declaration
public List<DialogFieldValue> GetDialogValues()
Returns
Type Description
System.Collections.Generic.List<DialogFieldValue>

GetEncryptableParams()

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

Declaration
protected override List<string> GetEncryptableParams()
Returns
Type Description
System.Collections.Generic.List<System.String>

List with all the parameters which might be encrypted.
Overrides

Parse(Dictionary<String, String>)

Declaration
public static DWIntegrationUrlParameters Parse(Dictionary<string, string> parameters)
Parameters
Type Name Description
System.Collections.Generic.Dictionary<System.String, System.String> parameters
Returns
Type Description
DWIntegrationUrlParameters

Parse(String)

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

Declaration
public static DWIntegrationUrlParameters Parse(string urlParamString)
Parameters
Type Name Description
System.String urlParamString

The string to parse
Returns
Type Description
DWIntegrationUrlParameters

A new instance of the DWIntegrationUrlParameters class.

SetDialogValues(List<DialogFieldValue>)

Sets the dialog values used in the integration by specifying a list of DialogFieldValue.

Declaration
public void SetDialogValues(List<DialogFieldValue> values)
Parameters
Type Name Description
System.Collections.Generic.List<DialogFieldValue> values

The list of DialogFieldValue to set.

SetDocIdValues(IEnumerable<Int32>)

Declaration
public void SetDocIdValues(IEnumerable<int> values)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.Int32> values

SetIntegrationParams(String, String)

Sets the value of a parameter.

Declaration
protected override 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

Returns true if successful or false if there is no parameter with such id.
Overrides

ToString()

Returns the parameters which are set as they will appear in the result url.

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()