Class ServiceDescriptionDocumentation

Inheritance

System.Object

ServiceDescriptionDocumentation

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class ServiceDescriptionDocumentation : IRelationsWithProxy

Properties

FunctionDescriptionsRelationLink

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

Declaration

public string FunctionDescriptionsRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “functionDescriptions” 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.

LinkModelOverviewRelationLink

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

Declaration

public string LinkModelOverviewRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “linkModelOverview” 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[]

SchemaSearchRelationLink

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

Declaration

public string SchemaSearchRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “schemaSearch” 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.

SchemasRelationLink

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

Declaration

public string SchemasRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “schemas” 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.

UriTemplatesDocumentationRelationLink

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

Declaration

public string UriTemplatesDocumentationRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “uriTemplatesDocumentation” 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

GetFunctionDescriptionsFromFunctionDescriptionsRelation()

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

Declaration

public FunctionDescriptions GetFunctionDescriptionsFromFunctionDescriptionsRelation()

Returns

Type	Description
FunctionDescriptions	The content of the response.

GetFunctionDescriptionsFromFunctionDescriptionsRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<FunctionDescriptions>> GetFunctionDescriptionsFromFunctionDescriptionsRelationAsync()

Returns

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

Remarks

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

GetFunctionDescriptionsFromFunctionDescriptionsRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<FunctionDescriptions>> GetFunctionDescriptionsFromFunctionDescriptionsRelationAsync(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<FunctionDescriptions>>	A task which runs the request.

Remarks

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

GetStreamFromLinkModelOverviewRelation()

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

Declaration

public System.IO.Stream GetStreamFromLinkModelOverviewRelation()

Returns

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

GetStreamFromLinkModelOverviewRelationAsync()

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

Declaration

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

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 “linkModelOverview”.

GetStreamFromLinkModelOverviewRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromLinkModelOverviewRelationAsync(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 “linkModelOverview”.

GetStreamFromSchemaSearchRelation()

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

Declaration

public System.IO.Stream GetStreamFromSchemaSearchRelation()

Returns

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

GetStreamFromSchemaSearchRelationAsync()

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

Declaration

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

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 “schemaSearch”.

GetStreamFromSchemaSearchRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromSchemaSearchRelationAsync(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 “schemaSearch”.

GetStreamFromUriTemplatesDocumentationRelation()

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

Declaration

public System.IO.Stream GetStreamFromUriTemplatesDocumentationRelation()

Returns

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

GetStreamFromUriTemplatesDocumentationRelationAsync()

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

Declaration

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

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 “uriTemplatesDocumentation”.

GetStreamFromUriTemplatesDocumentationRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromUriTemplatesDocumentationRelationAsync(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 “uriTemplatesDocumentation”.

GetXmlSchemasFromSchemasRelation()

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

Declaration

public XmlSchemas GetXmlSchemasFromSchemasRelation()

Returns

Type	Description
XmlSchemas	The content of the response.

GetXmlSchemasFromSchemasRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<XmlSchemas>> GetXmlSchemasFromSchemasRelationAsync()

Returns

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

Remarks

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

GetXmlSchemasFromSchemasRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<XmlSchemas>> GetXmlSchemasFromSchemasRelationAsync(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<XmlSchemas>>	A task which runs the request.

Remarks

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

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.