Class WorkshopClient

Inheritance

System.Object

WorkshopClient

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Simplic.PlugIn.Logistics.WebApi.Workshop

Assembly: Simplic.PlugIn.Logistics.dll

Syntax

public class WorkshopClient

Constructors

| Improve this Doc View Source

WorkshopClient(HttpClient)

Declaration

public WorkshopClient(HttpClient httpClient)

Parameters

Type	Name	Description
System.Net.Http.HttpClient	httpClient

Properties

| Improve this Doc View Source

BaseUrl

Declaration

public string BaseUrl { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

JsonSerializerSettings

Declaration

protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
Newtonsoft.Json.JsonSerializerSettings

| Improve this Doc View Source

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
System.Boolean

Methods

| Improve this Doc View Source

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)

Declaration

protected virtual async Task<WorkshopClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Net.Http.HttpResponseMessage	response
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>>	headers
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<WorkshopClient.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

| Improve this Doc View Source

WorkshopDeleteAsync(Guid)

Declaration

public virtual Task WorkshopDeleteAsync(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Returns

Type	Description
System.Threading.Tasks.Task	Success

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

WorkshopDeleteAsync(Guid, CancellationToken)

Declaration

public virtual async Task WorkshopDeleteAsync(Guid id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Guid	id
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task	Success

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

WorkshopGetAsync(Guid)

Declaration

public virtual Task<WorkshopModel> WorkshopGetAsync(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Returns

Type	Description
System.Threading.Tasks.Task<WorkshopModel>	Success

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

WorkshopGetAsync(Guid, CancellationToken)

Declaration

public virtual async Task<WorkshopModel> WorkshopGetAsync(Guid id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Guid	id
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<WorkshopModel>	Success

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

WorkshopPatchAsync(Guid, PatchWorkshopRequest)

Declaration

public virtual Task<WorkshopModel> WorkshopPatchAsync(Guid id, PatchWorkshopRequest body)

Parameters

Type	Name	Description
System.Guid	id
PatchWorkshopRequest	body

Returns

Type	Description
System.Threading.Tasks.Task<WorkshopModel>	Success

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

WorkshopPatchAsync(Guid, PatchWorkshopRequest, CancellationToken)

Declaration

public virtual async Task<WorkshopModel> WorkshopPatchAsync(Guid id, PatchWorkshopRequest body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Guid	id
PatchWorkshopRequest	body
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<WorkshopModel>	Success

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

WorkshopPostAsync(CreateWorkshopRequest)

Declaration

public virtual Task<WorkshopModel> WorkshopPostAsync(CreateWorkshopRequest body)

Parameters

Type	Name	Description
CreateWorkshopRequest	body

Returns

Type	Description
System.Threading.Tasks.Task<WorkshopModel>	Success

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

WorkshopPostAsync(CreateWorkshopRequest, CancellationToken)

Declaration

public virtual async Task<WorkshopModel> WorkshopPostAsync(CreateWorkshopRequest body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CreateWorkshopRequest	body
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<WorkshopModel>	Success

Exceptions

Type	Condition
ApiException	A server side error occurred.