ServiceDescription Class

DocuWare Platform .NET API

Inheritance Hierarchy

SystemObject
DocuWare.Platform.ServerClientServiceDescription

Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient (in DocuWare.Platform.ServerClient.dll) Version: Version 6.6

Syntax

Copy

[SerializableAttribute]
[XmlTypeAttribute(Namespace = "http://dev.docuware.com/schema/public/services/platform")]
[XmlRootAttribute(Namespace = "http://dev.docuware.com/schema/public/services/platform", 
	IsNullable = false)]
public class ServiceDescription : IRelationsWithProxy, 
	IRelations

The ServiceDescription type exposes the following members.

Constructors

	Name	Description
	ServiceDescription	Initializes a new instance of the ServiceDescription class

Top

Methods

	Name	Description
	GetAdhocRenderingFilesFromAdhocRenderingRelation	Calls the HTTP Get method on the link for the relation “adhocRendering”.
	GetAdhocRenderingFilesFromAdhocRenderingRelationAsync	Calls the HTTP Get method on the link for the relation “adhocRendering” asynchronously.
	GetOrganizationsFromOrganizationsRelation	Calls the HTTP Get method on the link for the relation “organizations”.
	GetOrganizationsFromOrganizationsRelationAsync	Calls the HTTP Get method on the link for the relation “organizations” asynchronously.
	GetStreamFromChangePasswordRelation	Calls the HTTP Get method on the link for the relation “changePassword”.
	GetStreamFromChangePasswordRelationAsync	Calls the HTTP Get method on the link for the relation “changePassword” asynchronously.
	GetStreamFromGuestLoginRelation	Calls the HTTP Get method on the link for the relation “guestLogin”.
	GetStreamFromGuestLoginRelationAsync	Calls the HTTP Get method on the link for the relation “guestLogin” asynchronously.
	GetStreamFromLoginRelation	Calls the HTTP Get method on the link for the relation “login”.
	GetStreamFromLoginRelationAsync	Calls the HTTP Get method on the link for the relation “login” asynchronously.
	GetStreamFromLogoutRelation	Calls the HTTP Get method on the link for the relation “logout”.
	GetStreamFromLogoutRelationAsync	Calls the HTTP Get method on the link for the relation “logout” asynchronously.
	GetStreamFromResetPasswordRelation	Calls the HTTP Get method on the link for the relation “resetPassword”.
	GetStreamFromResetPasswordRelationAsync	Calls the HTTP Get method on the link for the relation “resetPassword” asynchronously.
	GetStreamFromRootSchemaRelation	Calls the HTTP Get method on the link for the relation “rootSchema”.
	GetStreamFromRootSchemaRelationAsync	Calls the HTTP Get method on the link for the relation “rootSchema” asynchronously.
	GetStreamFromTokenLoginRelation	Calls the HTTP Get method on the link for the relation “tokenLogin”.
	GetStreamFromTokenLoginRelationAsync	Calls the HTTP Get method on the link for the relation “tokenLogin” asynchronously.
	GetStreamFromUriTemplatesRelation	Calls the HTTP Get method on the link for the relation “uriTemplates”.
	GetStreamFromUriTemplatesRelationAsync	Calls the HTTP Get method on the link for the relation “uriTemplates” asynchronously.
	GetStringFromLoginCookieRelation	Calls the HTTP Get method on the link for the relation “loginCookie”.
	GetStringFromLoginCookieRelationAsync	Calls the HTTP Get method on the link for the relation “loginCookie” asynchronously.
	GetStringFromPermanentUrlRelation	Calls the HTTP Get method on the link for the relation “permanentUrl”.
	GetStringFromPermanentUrlRelationAsync	Calls the HTTP Get method on the link for the relation “permanentUrl” asynchronously.
	GetStringFromWindowsLoginRelation	Calls the HTTP Get method on the link for the relation “windowsLogin”.
	GetStringFromWindowsLoginRelationAsync	Calls the HTTP Get method on the link for the relation “windowsLogin” asynchronously.
	PostToAdhocRenderingRelationForAdhocRenderingFile	Calls the HTTP Post method on the link for the relation “adhocRendering”.
	PostToAdhocRenderingRelationForAdhocRenderingFileAsync	Calls the HTTP Post method on the link for the relation “adhocRendering” asynchronously.
	PostToChangePasswordRelationForStream	Calls the HTTP Post method on the link for the relation “changePassword”.
	PostToChangePasswordRelationForStreamAsync	Calls the HTTP Post method on the link for the relation “changePassword” asynchronously.
	PostToGuestLoginRelationForStream	Calls the HTTP Post method on the link for the relation “guestLogin”.
	PostToGuestLoginRelationForStreamAsync	Calls the HTTP Post method on the link for the relation “guestLogin” asynchronously.
	PostToLoginRelationForStream	Calls the HTTP Post method on the link for the relation “login”.
	PostToLoginRelationForStreamAsync	Calls the HTTP Post method on the link for the relation “login” asynchronously.
	PostToResetPasswordRelationForStream	Calls the HTTP Post method on the link for the relation “resetPassword”.
	PostToResetPasswordRelationForStreamAsync	Calls the HTTP Post method on the link for the relation “resetPassword” asynchronously.
	PostToTokenLoginRelationForStream	Calls the HTTP Post method on the link for the relation “tokenLogin”.
	PostToTokenLoginRelationForStreamAsync	Calls the HTTP Post method on the link for the relation “tokenLogin” asynchronously.
	PostToWindowsLoginRelationForString	Calls the HTTP Post method on the link for the relation “windowsLogin”.
	PostToWindowsLoginRelationForStringAsync	Calls the HTTP Post method on the link for the relation “windowsLogin” asynchronously.

Top

Extension Methods

	Name	Description
	DeleteTResponse(String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(HttpClient, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(HttpClient, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetBaseUri	Gets the base URI of the specified relations instance. (Defined by RelationsWithProxyExtensions.)
	GetLink	Gets the link by its name. (Defined by RelationExtension.)
	GetRelationUri	Gets the URI of the relation specified by the name. (Defined by RelationExtension.)
	GetRelationUriOrThrow	Gets the URI of the relation specified by the name. (Defined by RelationExtension.)
	HasRelationUri	Determines whether the specified link exists. (Defined by RelationExtension.)
	SendTResponse(HttpMethod, String, String)	Overloaded. Sends a message to the specified proxy. (Defined by MethodInvocation.)
	SendTResponse(String, HttpMethod, HttpContent, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(HttpMethod, HttpClient, String, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(HttpClient, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)

Top

Properties

	Name	Description
	AdhocRenderingRelationLink	Gets the Uri of the link for the relation “adhocRendering”.
	ChangePasswordRelationLink	Gets the Uri of the link for the relation “changePassword”.
	Documentation
	GuestLoginRelationLink	Gets the Uri of the link for the relation “guestLogin”.
	Links
	LoginCookieRelationLink	Gets the Uri of the link for the relation “loginCookie”.
	LoginRelationLink	Gets the Uri of the link for the relation “login”.
	LogoutRelationLink	Gets the Uri of the link for the relation “logout”.
	LogRelationLink	Gets the Uri of the link for the relation “log”.
	OrganizationsRelationLink	Gets the Uri of the link for the relation “organizations”.
	PermanentUrlRelationLink	Gets the Uri of the link for the relation “permanentUrl”.
	ResetPasswordRelationLink	Gets the Uri of the link for the relation “resetPassword”.
	Resources
	RootSchemaRelationLink	Gets the Uri of the link for the relation “rootSchema”.
	Tests
	TokenLoginRelationLink	Gets the Uri of the link for the relation “tokenLogin”.
	UriTemplatesRelationLink	Gets the Uri of the link for the relation “uriTemplates”.
	Version	Contains the product version of DocuWare.
	WindowsLoginRelationLink	Gets the Uri of the link for the relation “windowsLogin”.

Top

Explicit Interface Implementations

	Name	Description
	IRelationsWithProxyProxy

Top

Remarks

Reference

DocuWare.Platform.ServerClient Namespace