Class ServiceConnectionExtensions

Inheritance

System.Object

ServiceConnectionExtensions

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public static class ServiceConnectionExtensions : object

Methods

CreatePermanentUrlAsync(ServiceConnection, String)

Creates a permanent URL asynchronously.

Declaration

public static System.Threading.Tasks.Task<DeserializedHttpResponse<string>> CreatePermanentUrlAsync(this ServiceConnection serviceConnection, string url)

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
System.String	url	The URL.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which creates a URL with an authenticated user information inside.

Remarks

Use this function to take an URL and append some information about the currently authenticated user. The created URL can then be taken to access the ressource without needed to login.

CreateTemplateUri(ServiceConnection, String, IEnumerable<KeyValuePair<String, Object>>)

Creates the template URI.

Declaration

public static string CreateTemplateUri(this ServiceConnection serviceConnection, string templateName, IEnumerable<KeyValuePair<string, object>> paramaters)

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
System.String	templateName	Name of the template.
IEnumerable<KeyValuePair<System.String, System.Object>>	paramaters	The paramaters.

Returns

Type	Description
System.String

CreateTemplateUri(ServiceConnection, String, Object)

Creates the template URI.

Declaration

public static string CreateTemplateUri(this ServiceConnection serviceConnection, string templateName, object paramaters)

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
System.String	templateName	Name of the template.
System.Object	paramaters	The paramaters.

Returns

Type	Description
System.String

GetAllFileCabinets(IEnumerable<Organization>)

Gets all file cabinets.

Declaration

public static List<FileCabinet> GetAllFileCabinets(this IEnumerable<Organization> organizations)

Parameters

Type	Name	Description
IEnumerable<Organization>	organizations	The organizations.

Returns

Type	Description
List<FileCabinet>	The list of all file cabinets.

GetFileCabinet(ServiceConnection, String)

Gets a FileCabinet instance directly.

Declaration

public static FileCabinet GetFileCabinet(this ServiceConnection serviceConnection, string fileCabinetId)

Parameters

Type	Name	Description
ServiceConnection	serviceConnection
System.String	fileCabinetId

Returns

Type	Description
FileCabinet

GetPermanentUrl(ServiceConnection, String)

Creates a permanent URL.

Declaration

public static string GetPermanentUrl(this ServiceConnection serviceConnection, string url)

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
System.String	url	The URL.

Returns

Type	Description
System.String	An URL with an authenticated user information inside.

Remarks

Use this function to take a URL and append some information about the currently authenticated user. The created URL can then be taken to access the ressource without needed to login.