Class ServiceDescription

Root object that define platform structure.

Inheritance

System.Object

ServiceDescription

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class ServiceDescription : IRelationsWithProxy

Properties

AdhocRenderingRelationLink

Gets the Uri of the link for the relation “adhocRendering”.

Declaration

public string AdhocRenderingRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “adhocRendering” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

ChangePasswordRelationLink

Gets the Uri of the link for the relation “changePassword”.

Declaration

public string ChangePasswordRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “changePassword” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

DisconnectRelationLink

Gets the Uri of the link for the relation “disconnect”.

Declaration

public string DisconnectRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “disconnect” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Documentation

Documentation links for platform.

Declaration

public ServiceDescriptionDocumentation Documentation { get; set; }

Property Value

Type	Description
ServiceDescriptionDocumentation

GuestLoginRelationLink

Gets the Uri of the link for the relation “guestLogin”.

Declaration

public string GuestLoginRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “guestLogin” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

IdentityServiceInfoRelationLink

Gets the Uri of the link for the relation “identityServiceInfo”.

Declaration

public string IdentityServiceInfoRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “identityServiceInfo” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

JwtLoginRelationLink

Gets the Uri of the link for the relation “jwtLogin”.

Declaration

public string JwtLoginRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “jwtLogin” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

LoginCookieRelationLink

Gets the Uri of the link for the relation “loginCookie”.

Declaration

public string LoginCookieRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “loginCookie” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

LoginRelationLink

Gets the Uri of the link for the relation “login”.

Declaration

public string LoginRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “login” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

LogoutRelationLink

Gets the Uri of the link for the relation “logout”.

Declaration

public string LogoutRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “logout” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

LogRelationLink

Gets the Uri of the link for the relation “log”.

Declaration

public string LogRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “log” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

OrganizationsRelationLink

Gets the Uri of the link for the relation “organizations”.

Declaration

public string OrganizationsRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “organizations” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

PermanentUrlRelationLink

Gets the Uri of the link for the relation “permanentUrl”.

Declaration

public string PermanentUrlRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “permanentUrl” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

ResetPasswordRelationLink

Gets the Uri of the link for the relation “resetPassword”.

Declaration

public string ResetPasswordRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “resetPassword” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Resources

Resource definitions/templates.

Declaration

public List<UriTemplateDescription> Resources { get; set; }

Property Value

Type	Description
List<UriTemplateDescription>

RootSchemaRelationLink

Gets the Uri of the link for the relation “rootSchema”.

Declaration

public string RootSchemaRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “rootSchema” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Statistics

Test applications for platform.

Declaration

public ServiceDescriptionStatistics Statistics { get; set; }

Property Value

Type	Description
ServiceDescriptionStatistics

Tests

Test applications for platform.

Declaration

public ServiceDescriptionTests Tests { get; set; }

Property Value

Type	Description
ServiceDescriptionTests

TokenLoginRelationLink

Gets the Uri of the link for the relation “tokenLogin”.

Declaration

public string TokenLoginRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “tokenLogin” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

TrustedLoginRelationLink

Gets the Uri of the link for the relation “trustedLogin”.

Declaration

public string TrustedLoginRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “trustedLogin” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

UriTemplatesRelationLink

Gets the Uri of the link for the relation “uriTemplates”.

Declaration

public string UriTemplatesRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “uriTemplates” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Version

Contains the product version of DocuWare.

Declaration

public string Version { get; set; }

Property Value

Type	Description
System.String

WindowsLoginRelationLink

Gets the Uri of the link for the relation “windowsLogin”.

Declaration

public string WindowsLoginRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “windowsLogin” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Methods

GetAdhocRenderingFilesFromAdhocRenderingRelation()

Calls the HTTP Get method on the link for the relation “adhocRendering”.

Declaration

public AdhocRenderingFiles GetAdhocRenderingFilesFromAdhocRenderingRelation()

Returns

Type	Description
AdhocRenderingFiles	The content of the response.

GetAdhocRenderingFilesFromAdhocRenderingRelationAsync()

Calls the HTTP Get method on the link for the relation “adhocRendering” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<AdhocRenderingFiles>> GetAdhocRenderingFilesFromAdhocRenderingRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<AdhocRenderingFiles>>	A task which runs the request.

Remarks

This method follows the link for the relation “adhocRendering”.

GetAdhocRenderingFilesFromAdhocRenderingRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “adhocRendering” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<AdhocRenderingFiles>> GetAdhocRenderingFilesFromAdhocRenderingRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<AdhocRenderingFiles>>	A task which runs the request.

Remarks

This method follows the link for the relation “adhocRendering”.

GetIdentityServiceInfoFromIdentityServiceInfoRelation()

Calls the HTTP Get method on the link for the relation “identityServiceInfo”.

Declaration

public IdentityServiceInfo GetIdentityServiceInfoFromIdentityServiceInfoRelation()

Returns

Type	Description
IdentityServiceInfo	The content of the response.

GetIdentityServiceInfoFromIdentityServiceInfoRelationAsync()

Calls the HTTP Get method on the link for the relation “identityServiceInfo” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<IdentityServiceInfo>> GetIdentityServiceInfoFromIdentityServiceInfoRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<IdentityServiceInfo>>	A task which runs the request.

Remarks

This method follows the link for the relation “identityServiceInfo”.

GetIdentityServiceInfoFromIdentityServiceInfoRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “identityServiceInfo” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<IdentityServiceInfo>> GetIdentityServiceInfoFromIdentityServiceInfoRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<IdentityServiceInfo>>	A task which runs the request.

Remarks

This method follows the link for the relation “identityServiceInfo”.

GetOrganizationsFromOrganizationsRelation()

Calls the HTTP Get method on the link for the relation “organizations”.

Declaration

public Organizations GetOrganizationsFromOrganizationsRelation()

Returns

Type	Description
Organizations	The content of the response.

GetOrganizationsFromOrganizationsRelationAsync()

Calls the HTTP Get method on the link for the relation “organizations” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Organizations>> GetOrganizationsFromOrganizationsRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Organizations>>	A task which runs the request.

Remarks

This method follows the link for the relation “organizations”.

GetOrganizationsFromOrganizationsRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “organizations” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Organizations>> GetOrganizationsFromOrganizationsRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Organizations>>	A task which runs the request.

Remarks

This method follows the link for the relation “organizations”.

GetStreamFromChangePasswordRelation()

Calls the HTTP Get method on the link for the relation “changePassword”.

Declaration

public System.IO.Stream GetStreamFromChangePasswordRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromChangePasswordRelationAsync()

Calls the HTTP Get method on the link for the relation “changePassword” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromChangePasswordRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “changePassword”.

GetStreamFromChangePasswordRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “changePassword” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromChangePasswordRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “changePassword”.

GetStreamFromDisconnectRelation()

Calls the HTTP Get method on the link for the relation “disconnect”.

Declaration

public System.IO.Stream GetStreamFromDisconnectRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromDisconnectRelationAsync()

Calls the HTTP Get method on the link for the relation “disconnect” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromDisconnectRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “disconnect”.

GetStreamFromDisconnectRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “disconnect” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromDisconnectRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “disconnect”.

GetStreamFromGuestLoginRelation()

Calls the HTTP Get method on the link for the relation “guestLogin”.

Declaration

public System.IO.Stream GetStreamFromGuestLoginRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromGuestLoginRelationAsync()

Calls the HTTP Get method on the link for the relation “guestLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromGuestLoginRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “guestLogin”.

GetStreamFromGuestLoginRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “guestLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromGuestLoginRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “guestLogin”.

GetStreamFromLoginRelation()

Calls the HTTP Get method on the link for the relation “login”.

Declaration

public System.IO.Stream GetStreamFromLoginRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromLoginRelationAsync()

Calls the HTTP Get method on the link for the relation “login” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromLoginRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “login”.

GetStreamFromLoginRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “login” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromLoginRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “login”.

GetStreamFromLogoutRelation()

Calls the HTTP Get method on the link for the relation “logout”.

Declaration

public System.IO.Stream GetStreamFromLogoutRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromLogoutRelationAsync()

Calls the HTTP Get method on the link for the relation “logout” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromLogoutRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “logout”.

GetStreamFromLogoutRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “logout” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromLogoutRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “logout”.

GetStreamFromResetPasswordRelation()

Calls the HTTP Get method on the link for the relation “resetPassword”.

Declaration

public System.IO.Stream GetStreamFromResetPasswordRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromResetPasswordRelationAsync()

Calls the HTTP Get method on the link for the relation “resetPassword” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromResetPasswordRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “resetPassword”.

GetStreamFromResetPasswordRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “resetPassword” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromResetPasswordRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “resetPassword”.

GetStreamFromRootSchemaRelation()

Calls the HTTP Get method on the link for the relation “rootSchema”.

Declaration

public System.IO.Stream GetStreamFromRootSchemaRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromRootSchemaRelationAsync()

Calls the HTTP Get method on the link for the relation “rootSchema” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromRootSchemaRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “rootSchema”.

GetStreamFromRootSchemaRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “rootSchema” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromRootSchemaRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “rootSchema”.

GetStreamFromTokenLoginRelation()

Calls the HTTP Get method on the link for the relation “tokenLogin”.

Declaration

public System.IO.Stream GetStreamFromTokenLoginRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromTokenLoginRelationAsync()

Calls the HTTP Get method on the link for the relation “tokenLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromTokenLoginRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “tokenLogin”.

GetStreamFromTokenLoginRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “tokenLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromTokenLoginRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “tokenLogin”.

GetStreamFromTrustedLoginRelation()

Calls the HTTP Get method on the link for the relation “trustedLogin”.

Declaration

public System.IO.Stream GetStreamFromTrustedLoginRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromTrustedLoginRelationAsync()

Calls the HTTP Get method on the link for the relation “trustedLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromTrustedLoginRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “trustedLogin”.

GetStreamFromTrustedLoginRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “trustedLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromTrustedLoginRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “trustedLogin”.

GetStringFromLoginCookieRelation()

Calls the HTTP Get method on the link for the relation “loginCookie”.

Declaration

public string GetStringFromLoginCookieRelation()

Returns

Type	Description
System.String	The content of the response.

GetStringFromLoginCookieRelationAsync()

Calls the HTTP Get method on the link for the relation “loginCookie” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> GetStringFromLoginCookieRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

This method follows the link for the relation “loginCookie”.

GetStringFromLoginCookieRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “loginCookie” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> GetStringFromLoginCookieRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

This method follows the link for the relation “loginCookie”.

GetStringFromPermanentUrlRelation()

Calls the HTTP Get method on the link for the relation “permanentUrl”.

Declaration

public string GetStringFromPermanentUrlRelation()

Returns

Type	Description
System.String	The content of the response.

GetStringFromPermanentUrlRelationAsync()

Calls the HTTP Get method on the link for the relation “permanentUrl” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> GetStringFromPermanentUrlRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

This method follows the link for the relation “permanentUrl”.

GetStringFromPermanentUrlRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “permanentUrl” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> GetStringFromPermanentUrlRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

This method follows the link for the relation “permanentUrl”.

GetStringFromWindowsLoginRelation()

Calls the HTTP Get method on the link for the relation “windowsLogin”.

Declaration

public string GetStringFromWindowsLoginRelation()

Returns

Type	Description
System.String	The content of the response.

GetStringFromWindowsLoginRelationAsync()

Calls the HTTP Get method on the link for the relation “windowsLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> GetStringFromWindowsLoginRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

This method follows the link for the relation “windowsLogin”.

GetStringFromWindowsLoginRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “windowsLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> GetStringFromWindowsLoginRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

This method follows the link for the relation “windowsLogin”.

PostToAdhocRenderingRelationForAdhocRenderingFile(String, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “adhocRendering”.

Declaration

public AdhocRenderingFile PostToAdhocRenderingRelationForAdhocRenderingFile(string requestedContentType, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.String	requestedContentType	Mime type of the requested body content, i.e. application/pdf.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
AdhocRenderingFile	The content of the response.

PostToAdhocRenderingRelationForAdhocRenderingFileAsync(String, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “adhocRendering” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<AdhocRenderingFile>> PostToAdhocRenderingRelationForAdhocRenderingFileAsync(string requestedContentType, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.String	requestedContentType	Mime type of the requested body content, i.e. application/pdf.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<AdhocRenderingFile>>	A task which runs the request.

Remarks

This method follows the link for the relation “adhocRendering”.

PostToAdhocRenderingRelationForAdhocRenderingFileAsync(System.Threading.CancellationToken, String, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “adhocRendering” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<AdhocRenderingFile>> PostToAdhocRenderingRelationForAdhocRenderingFileAsync(System.Threading.CancellationToken cancellationToken, string requestedContentType, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
System.String	requestedContentType	Mime type of the requested body content, i.e. application/pdf.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<AdhocRenderingFile>>	A task which runs the request.

Remarks

This method follows the link for the relation “adhocRendering”.

PostToChangePasswordRelationForStream(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “changePassword”.

Declaration

public System.IO.Stream PostToChangePasswordRelationForStream(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToChangePasswordRelationForStreamAsync(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “changePassword” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToChangePasswordRelationForStreamAsync(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “changePassword”.

PostToChangePasswordRelationForStreamAsync(System.Threading.CancellationToken, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “changePassword” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToChangePasswordRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “changePassword”.

PostToGuestLoginRelationForStream(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “guestLogin”.

Declaration

public System.IO.Stream PostToGuestLoginRelationForStream(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToGuestLoginRelationForStreamAsync(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “guestLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToGuestLoginRelationForStreamAsync(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “guestLogin”.

PostToGuestLoginRelationForStreamAsync(System.Threading.CancellationToken, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “guestLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToGuestLoginRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “guestLogin”.

PostToJwtLoginRelationForStream(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “jwtLogin”.

Declaration

public System.IO.Stream PostToJwtLoginRelationForStream(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToJwtLoginRelationForStreamAsync(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “jwtLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToJwtLoginRelationForStreamAsync(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “jwtLogin”.

PostToJwtLoginRelationForStreamAsync(System.Threading.CancellationToken, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “jwtLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToJwtLoginRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “jwtLogin”.

PostToLoginRelationForStream(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “login”.

Declaration

public System.IO.Stream PostToLoginRelationForStream(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToLoginRelationForStreamAsync(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “login” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToLoginRelationForStreamAsync(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “login”.

PostToLoginRelationForStreamAsync(System.Threading.CancellationToken, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “login” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToLoginRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “login”.

PostToResetPasswordRelationForStream(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “resetPassword”.

Declaration

public System.IO.Stream PostToResetPasswordRelationForStream(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToResetPasswordRelationForStreamAsync(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “resetPassword” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToResetPasswordRelationForStreamAsync(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “resetPassword”.

PostToResetPasswordRelationForStreamAsync(System.Threading.CancellationToken, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “resetPassword” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToResetPasswordRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “resetPassword”.

PostToTokenLoginRelationForStream(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “tokenLogin”.

Declaration

public System.IO.Stream PostToTokenLoginRelationForStream(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToTokenLoginRelationForStreamAsync(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “tokenLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToTokenLoginRelationForStreamAsync(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “tokenLogin”.

PostToTokenLoginRelationForStreamAsync(System.Threading.CancellationToken, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “tokenLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToTokenLoginRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “tokenLogin”.

PostToTrustedLoginRelationForStream(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “trustedLogin”.

Declaration

public System.IO.Stream PostToTrustedLoginRelationForStream(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToTrustedLoginRelationForStreamAsync(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “trustedLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToTrustedLoginRelationForStreamAsync(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “trustedLogin”.

PostToTrustedLoginRelationForStreamAsync(System.Threading.CancellationToken, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “trustedLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToTrustedLoginRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “trustedLogin”.

PostToWindowsLoginRelationForString(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “windowsLogin”.

Declaration

public string PostToWindowsLoginRelationForString(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.String	The content of the response.

PostToWindowsLoginRelationForStringAsync(System.IO.Stream)

Calls the HTTP Post method on the link for the relation “windowsLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToWindowsLoginRelationForStringAsync(System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

This method follows the link for the relation “windowsLogin”.

PostToWindowsLoginRelationForStringAsync(System.Threading.CancellationToken, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “windowsLogin” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToWindowsLoginRelationForStringAsync(System.Threading.CancellationToken cancellationToken, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

This method follows the link for the relation “windowsLogin”.

SetProxy(HttpClientProxy)

Sets the HTTP communication proxy which is used in further HTTP communication.

Declaration

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The instance which is used in further HTTP communication.

Remarks

The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.