Show / Hide Table of Contents

    Class DWWebLoginInfo

    Class containing the basic login information used for both integration login and web login.

    Inheritance
    System.Object
    DWWebLoginInfo
    DWIntegrationInfo
    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 DWWebLoginInfo

    Constructors

    DWWebLoginInfo(String)

    Initializes a new instance of the DWWebLoginInfo class.

    Declaration
    public DWWebLoginInfo(string httpAddress)
    Parameters
    Type Name Description
    System.String httpAddress

    String specifying the HTTP address

    DWWebLoginInfo(String, Boolean)

    Declaration
    public DWWebLoginInfo(string webClientUrl, bool useSso)
    Parameters
    Type Name Description
    System.String webClientUrl
    System.Boolean useSso

    DWWebLoginInfo(String, Guid, Boolean)

    Initializes a new instance of the DWWebLoginInfo class.

    Declaration
    public DWWebLoginInfo(string webClientUrl, Guid orgGuId, bool useSso)
    Parameters
    Type Name Description
    System.String webClientUrl
    System.Guid orgGuId

    The Organization GUID

    System.Boolean useSso

    Boolean parameter specifying whether to use single sign-on.

    DWWebLoginInfo(String, Int32, Boolean)

    Initializes a new instance of the DWWebLoginInfo class.

    Declaration
    public DWWebLoginInfo(string webClientUrl, int orgId, bool useSso)
    Parameters
    Type Name Description
    System.String webClientUrl
    System.Int32 orgId

    The Organization ID

    System.Boolean useSso

    Boolean parameter specifying whether to use single sign-on.

    DWWebLoginInfo(String, String, Boolean)

    Declaration
    protected DWWebLoginInfo(string webClientUrl, string orgName, bool useSso)
    Parameters
    Type Name Description
    System.String webClientUrl
    System.String orgName
    System.Boolean useSso

    Fields

    _isEncrypted

    Boolean variable indicating whether the integration info is encrypted.

    Declaration
    protected bool _isEncrypted
    Field Value
    Type Description
    System.Boolean

    Properties

    IsEncrypted

    Returns always true.

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

    OrganizationId

    The id of the organization for this Integration.

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

    Scheme

    Returs "http" or "https" depending on the Scheme.

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

    UseSso

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

    Version

    In our first implementation, always returns UrlVersion.51bSP2.

    Declaration
    public UrlVersion Version { get; set; }
    Property Value
    Type Description
    UrlVersion

    WebClientUrl

    This is the AdminTool | DocuWare System | WebConnections | Web Client | URL

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

    Methods

    AddQueryParams(Dictionary<String, String>)

    Initializes parameters from dictionary with key, value pair.

    Declaration
    protected virtual void AddQueryParams(Dictionary<string, string> par)
    Parameters
    Type Name Description
    System.Collections.Generic.Dictionary<System.String, System.String> par

    ArrayContains(String[], String)

    For internal use only

    Declaration
    protected static bool ArrayContains(string[] array, string value)
    Parameters
    Type Name Description
    System.String[] array
    System.String value
    Returns
    Type Description
    System.Boolean

    Parse(String)

    Tries to parse a DWIntegrationInfo object from the passed url string. Returns null if this is not possible.

    Declaration
    public static DWWebLoginInfo Parse(string urlString)
    Parameters
    Type Name Description
    System.String urlString
    Returns
    Type Description
    DWWebLoginInfo

    ParseBaseUrl(String)

    For internal use only

    Declaration
    protected void ParseBaseUrl(string httpAddress)
    Parameters
    Type Name Description
    System.String httpAddress

    ParseInternal(String)

    For internal use only

    Declaration
    protected void ParseInternal(string urlString)
    Parameters
    Type Name Description
    System.String urlString
    About Us Contact Imprint Terms Data privacy
    © 2024 DocuWare Corporation powered by DocFX Back to top