Class RestServiceConnectionInfo

Class for creating a connection string that will be used with a REST service instance

Inheritance
System.Object
ReportEngineConnectionInfoBase
RemoteConnectionInfo
RestServiceConnectionInfo
Inherited Members
Namespace: Telerik.ReportViewer.Common
Assembly: Telerik.ReportViewer.WinForms.dll

Syntax

public class RestServiceConnectionInfo : RemoteConnectionInfo
Examples
private void SetRestServiceReportEngineConnection(object sender, System.EventArgs e)
{
    this.reportViewer1.ReportEngineConnection = new Telerik.ReportViewer.Common.RestServiceConnectionInfo("http://servicehost:83/api/reports", "authToken", 20).ConnectionString;
}

Private Sub SetRestServiceReportEngineConnection(sender As Object, e As System.EventArgs)
    Me.ReportViewer1.ReportEngineConnection = New Telerik.ReportViewer.Common.RestServiceConnectionInfo("http://servicehost:83/api/reports", "authToken", 20).ConnectionString
End Sub

Constructors

RestServiceConnectionInfo(String)

Class for creating a connection string that will be used with a REST service instance

Declaration
public RestServiceConnectionInfo(string uri)
Parameters
System.String uri

The URI of /api/reports endpoint the REST service. Example: http://localhost:58619/api/reports

RestServiceConnectionInfo(String, Boolean)

Class for creating a connection string that will be used with a REST service instance

Declaration
public RestServiceConnectionInfo(string uri, bool useDefaultCredentials)
Parameters
System.String uri

The URI of /api/reports endpoint the REST service. Example: http://localhost:58619/api/reports
System.Boolean useDefaultCredentials

Determines if the default credentials will be sent

RestServiceConnectionInfo(String, Int32)

Class for creating a connection string that will be used with a REST service instance

Declaration
public RestServiceConnectionInfo(string uri, int timeout)
Parameters
System.String uri

The URI of /api/reports endpoint the REST service. Example: http://localhost:58619/api/reports
System.Int32 timeout

The timeout for rendering a document measured in seconds

RestServiceConnectionInfo(String, String)

Class for creating a connection string that will be used with a REST service instance

Declaration
public RestServiceConnectionInfo(string uri, string token)
Parameters
System.String uri

The URI of /api/reports endpoint the REST service. Example: http://localhost:58619/api/reports
System.String token

Authentication token to be sent with each request

RestServiceConnectionInfo(String, String, Boolean)

Class for creating a connection string that will be used with a REST service instance

Declaration
public RestServiceConnectionInfo(string uri, string token, bool useDefaultCredentials)
Parameters
System.String uri

The URI of /api/reports endpoint the REST service. Example: http://localhost:58619/api/reports
System.String token

Authentication token to be sent with each request
System.Boolean useDefaultCredentials

Determines if the default credentials will be sent

RestServiceConnectionInfo(String, String, Boolean, Int32)

Class for creating a connection string that will be used with a REST service instance

Declaration
public RestServiceConnectionInfo(string uri, string token, bool useDefaultCredentials, int timeout)
Parameters
System.String uri

The URI of /api/reports endpoint the REST service. Example: http://localhost:58619/api/reports
System.String token

Authentication token to be sent with each request
System.Boolean useDefaultCredentials

Determines if the default credentials will be sent
System.Int32 timeout

The timeout for rendering a document measured in seconds

RestServiceConnectionInfo(String, String, Boolean, Int32, Boolean)

Class for creating a connection string that will be used with a REST service instance

Declaration
public RestServiceConnectionInfo(string uri, string token, bool useDefaultCredentials, int timeout, bool keepClientAlive)
Parameters
System.String uri

The URI of /api/reports endpoint the REST service. Example: http://localhost:58619/api/reports
System.String token

Authentication token to be sent with each request
System.Boolean useDefaultCredentials

Determines if the default credentials will be sent
System.Int32 timeout

The timeout for rendering a document measured in seconds
System.Boolean keepClientAlive

Determines if the client will be kept alive (will not be expired)

RestServiceConnectionInfo(String, String, Int32)

Class for creating a connection string that will be used with a REST service instance

Declaration
public RestServiceConnectionInfo(string uri, string token, int timeout)
Parameters
System.String uri

The URI of /api/reports endpoint the REST service. Example: http://localhost:58619/api/reports
System.String token

Authentication token to be sent with each request
System.Int32 timeout

The timeout for rendering a document measured in seconds

Properties

Token

Gets or sets authentication token

Declaration
public string Token { get; set; }
Property Value
System.String

UseDefaultCredentials

Determines if the default credentials to be set when connecting to report engine

Declaration
public bool UseDefaultCredentials { get; set; }
Property Value
System.Boolean