Class RVHeadersDataSourceCredentials

The class used to represent authentication using headers (including cookies), supported only by Web Resource and REST API data sources. When sending HTTP requests to get data for the data source, the specified headers will be included.

Inheritance
System.Object
RVHeadersDataSourceCredentials
Implements
Namespace: Reveal.Sdk
Assembly: Infragistics.Reveal.SDK.Server.dll
Syntax
public class RVHeadersDataSourceCredentials : Object, IRVDataSourceCredential

Constructors

RVHeadersDataSourceCredentials()

Creates an empty headers credentials object, you can use AddHeader(String, String) to add headers.

Declaration
public RVHeadersDataSourceCredentials()

RVHeadersDataSourceCredentials(Dictionary<String, String>)

Constructor used to indicate the headers that should be included in data requests.

Declaration
public RVHeadersDataSourceCredentials(Dictionary<string, string> headers)
Parameters
Type Name Description
System.Collections.Generic.Dictionary<System.String, System.String> headers

A map with the headers to send, supports only single-valued headers.

RVHeadersDataSourceCredentials(String, String)

Helper constructor to create a headers credentials with a single header, you can add additional headers with AddHeader(String, String).

Declaration
public RVHeadersDataSourceCredentials(string singleHeaderName, string singleHeaderValue)
Parameters
Type Name Description
System.String singleHeaderName

Header name, it will be ignored if null

System.String singleHeaderValue

Header value, it will be ignored if null

Properties

Headers

Declaration
public Dictionary<string, string> Headers { get; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.String>

Methods

AddHeader(String, String)

Adds a new header to this credentials object.

Declaration
public void AddHeader(string name, string value)
Parameters
Type Name Description
System.String name

Header name, it will be ignored if null

System.String value

Header value, it will be ignored if null

Implements

IRVDataSourceCredential