Class ServiceConnectionExtensions

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

public static class ServiceConnectionExtensions

Inheritance

object

ServiceConnectionExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

CreatePermanentUrlAsync(ServiceConnection, string)

Creates a permanent URL asynchronously.

public static Task<DeserializedHttpResponse<string>> CreatePermanentUrlAsync(this ServiceConnection serviceConnection, string url)

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
string	url	The URL.

Returns

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

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

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
string	templateName	Name of the template.
IEnumerable<KeyValuePair<string, object>>	paramaters	The paramaters.

Returns

Type	Description
string

CreateTemplateUri(ServiceConnection, string, object)

Creates the template URI.

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

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
string	templateName	Name of the template.
object	paramaters	The paramaters.

Returns

Type	Description
string

GetAllFileCabinets(IEnumerable<Organization>)

Gets all file cabinets.

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.

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

Parameters

Type	Name	Description
ServiceConnection	serviceConnection
string	fileCabinetId

Returns

Type	Description
FileCabinet

GetPermanentUrl(ServiceConnection, string)

Creates a permanent URL.

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

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
string	url	The URL.

Returns

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