Class ServiceDescriptionDocumentation

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

public class ServiceDescriptionDocumentation : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

ServiceDescriptionDocumentation

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

FunctionDescriptionsRelationLink

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

public string FunctionDescriptionsRelationLink { get; }

Property Value

Type	Description
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”.

public string LinkModelOverviewRelationLink { get; }

Property Value

Type	Description
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

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

SchemaSearchRelationLink

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

public string SchemaSearchRelationLink { get; }

Property Value

Type	Description
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”.

public string SchemasRelationLink { get; }

Property Value

Type	Description
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”.

public string UriTemplatesDocumentationRelationLink { get; }

Property Value

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<FunctionDescriptions>> GetFunctionDescriptionsFromFunctionDescriptionsRelationAsync()

Returns

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

Remarks

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

GetFunctionDescriptionsFromFunctionDescriptionsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<FunctionDescriptions>> GetFunctionDescriptionsFromFunctionDescriptionsRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
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”.

public Stream GetStreamFromLinkModelOverviewRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromLinkModelOverviewRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromLinkModelOverviewRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Stream>>	A task which runs the request.

Remarks

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

GetStreamFromLinkModelOverviewRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromLinkModelOverviewRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Task<DeserializedHttpResponse<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”.

public Stream GetStreamFromSchemaSearchRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromSchemaSearchRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromSchemaSearchRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Stream>>	A task which runs the request.

Remarks

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

GetStreamFromSchemaSearchRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromSchemaSearchRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Task<DeserializedHttpResponse<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”.

public Stream GetStreamFromUriTemplatesDocumentationRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromUriTemplatesDocumentationRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromUriTemplatesDocumentationRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Stream>>	A task which runs the request.

Remarks

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

GetStreamFromUriTemplatesDocumentationRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromUriTemplatesDocumentationRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Task<DeserializedHttpResponse<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”.

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.

public Task<DeserializedHttpResponse<XmlSchemas>> GetXmlSchemasFromSchemasRelationAsync()

Returns

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

Remarks

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

GetXmlSchemasFromSchemasRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<XmlSchemas>> GetXmlSchemasFromSchemasRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
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.

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The 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.