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

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

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

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.

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

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

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.

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

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

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

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

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

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.

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

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

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.

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

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

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.

Declaration
public Link[] Links { get; set; }
Property Value
Type Description
Link[]

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

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

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.

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

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

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.

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

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

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.

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

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

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.

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

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

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.

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

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

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.

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

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

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
System.Collections.Generic.List<UriTemplateDescription>

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

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

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

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

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

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.

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

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

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.

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

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

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
[Dolphin]
public string Version { get; set; }
Property Value
Type Description
System.String

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

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

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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<AdhocRenderingFiles>> GetAdhocRenderingFilesFromAdhocRenderingRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<IdentityServiceInfo>> GetIdentityServiceInfoFromIdentityServiceInfoRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Organizations>> GetOrganizationsFromOrganizationsRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromChangePasswordRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromDisconnectRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromGuestLoginRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromLoginRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromLogoutRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromResetPasswordRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromRootSchemaRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromTokenLoginRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromTrustedLoginRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<string>> GetStringFromLoginCookieRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<string>> GetStringFromPermanentUrlRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<string>> GetStringFromWindowsLoginRelationAsync(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, Stream)

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

Declaration
public AdhocRenderingFile PostToAdhocRenderingRelationForAdhocRenderingFile(string requestedContentType, 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, Stream)

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

Declaration
public Task<DeserializedHttpResponse<AdhocRenderingFile>> PostToAdhocRenderingRelationForAdhocRenderingFileAsync(string requestedContentType, 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(CancellationToken, String, Stream)

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

Declaration
public Task<DeserializedHttpResponse<AdhocRenderingFile>> PostToAdhocRenderingRelationForAdhocRenderingFileAsync(CancellationToken cancellationToken, string requestedContentType, 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(Stream)

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

Declaration
public Stream PostToChangePasswordRelationForStream(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(Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToChangePasswordRelationForStreamAsync(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(CancellationToken, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToChangePasswordRelationForStreamAsync(CancellationToken cancellationToken, 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(Stream)

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

Declaration
public Stream PostToGuestLoginRelationForStream(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(Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToGuestLoginRelationForStreamAsync(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(CancellationToken, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToGuestLoginRelationForStreamAsync(CancellationToken cancellationToken, 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(Stream)

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

Declaration
public Stream PostToJwtLoginRelationForStream(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(Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToJwtLoginRelationForStreamAsync(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(CancellationToken, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToJwtLoginRelationForStreamAsync(CancellationToken cancellationToken, 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(Stream)

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

Declaration
public Stream PostToLoginRelationForStream(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(Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToLoginRelationForStreamAsync(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(CancellationToken, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToLoginRelationForStreamAsync(CancellationToken cancellationToken, 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(Stream)

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

Declaration
public Stream PostToResetPasswordRelationForStream(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(Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToResetPasswordRelationForStreamAsync(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(CancellationToken, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToResetPasswordRelationForStreamAsync(CancellationToken cancellationToken, 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(Stream)

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

Declaration
public Stream PostToTokenLoginRelationForStream(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(Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToTokenLoginRelationForStreamAsync(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(CancellationToken, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToTokenLoginRelationForStreamAsync(CancellationToken cancellationToken, 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(Stream)

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

Declaration
public Stream PostToTrustedLoginRelationForStream(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(Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToTrustedLoginRelationForStreamAsync(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(CancellationToken, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToTrustedLoginRelationForStreamAsync(CancellationToken cancellationToken, 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(Stream)

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

Declaration
public string PostToWindowsLoginRelationForString(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(Stream)

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

Declaration
public Task<DeserializedHttpResponse<string>> PostToWindowsLoginRelationForStringAsync(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(CancellationToken, Stream)

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

Declaration
public Task<DeserializedHttpResponse<string>> PostToWindowsLoginRelationForStringAsync(CancellationToken cancellationToken, 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 System.Net.Http.HttpClient 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.