Class ClientBase

Client base

Inheritance

System.Object

ClientBase

Client

CRUDClientBase<R, T, I>

EventQueueClient

DataPortClient

ProfileClient

Implements

System.IDisposable

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.Cloud.API

Assembly: Simplic.Cloud.API.dll

Syntax

public abstract class ClientBase : IDisposable

Constructors

| Improve this Doc View Source

ClientBase()

Initialize client base

Declaration

public ClientBase()

| Improve this Doc View Source

ClientBase(IClient)

Initialize new client base and copy important information

Declaration

public ClientBase(IClient clientBase)

Parameters

Type	Name	Description
IClient	clientBase	Client base instance

Exceptions

Type	Condition
System.ArgumentNullException	Null check for ClientBase argument.

| Improve this Doc View Source

ClientBase(String)

Initialize client base with custom url

Declaration

public ClientBase(string url)

Parameters

Type	Name	Description
System.String	url	Base url

Fields

| Improve this Doc View Source

ApiVersion

Declaration

public const string ApiVersion = "v1-0"

Field Value

Type	Description
System.String

| Improve this Doc View Source

DefaultUrl

Declaration

public const string DefaultUrl = "https://cloud.simplic.io"

Field Value

Type	Description
System.String

Properties

| Improve this Doc View Source

HttpClient

Gets the http client instance

Declaration

protected HttpClient HttpClient { get; }

Property Value

Type	Description
System.Net.Http.HttpClient

| Improve this Doc View Source

Url

Gets the client url

Declaration

public string Url { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

User

Gets or sets the current jwt. Get is protected for security reason. However, the getter can be accesses by using reflection.

Declaration

public User User { get; set; }

Property Value

Type	Description
User

Methods

| Improve this Doc View Source

DeleteAsync<T>(String, String, String, IDictionary<String, String>)

Get async

Declaration

protected async Task<T> DeleteAsync<T>(string api, string controller, string action, IDictionary<string, string> parameters)

Parameters

Type	Name	Description
System.String	api	Api path
System.String	controller	Controller
System.String	action	Action
System.Collections.Generic.IDictionary<System.String, System.String>	parameters	List of optional parameter

Returns

Type	Description
System.Threading.Tasks.Task<T>	Return model

Type Parameters

Name	Description
T	Return type

| Improve this Doc View Source

Dispose()

Dispose object

Declaration

public void Dispose()

| Improve this Doc View Source

GetAsync<T>(String, String, String, IDictionary<String, String>)

Get async

Declaration

protected async Task<T> GetAsync<T>(string api, string controller, string action, IDictionary<string, string> parameters)

Parameters

Type	Name	Description
System.String	api	Api path
System.String	controller	Controller
System.String	action	Action
System.Collections.Generic.IDictionary<System.String, System.String>	parameters	List of optional parameter

Returns

Type	Description
System.Threading.Tasks.Task<T>	Return model

Type Parameters

Name	Description
T	Return type

| Improve this Doc View Source

PostAsync<T, I>(String, String, String, I)

Post async

Declaration

protected async Task<T> PostAsync<T, I>(string api, string controller, string action, I model)

Parameters

Type	Name	Description
System.String	api	Api path
System.String	controller	Controller
System.String	action	Action
I	model	Model to post

Returns

Type	Description
System.Threading.Tasks.Task<T>	Return model

Type Parameters

Name	Description
T	Return type
I	Model type

| Improve this Doc View Source

PostMultipartAsync(String, String, String, Byte[], IDictionary<String, String>)

Declaration

protected async Task PostMultipartAsync(string api, string controller, string action, byte[] blob, IDictionary<string, string> formData)

Parameters

Type	Name	Description
System.String	api
System.String	controller
System.String	action
System.Byte[]	blob
System.Collections.Generic.IDictionary<System.String, System.String>	formData

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

PutAsync<T, I>(String, String, String, I)

Declaration

protected async Task<T> PutAsync<T, I>(string api, string controller, string action, I model)

Parameters

Type	Name	Description
System.String	api
System.String	controller
System.String	action
I	model

Returns

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

Type Parameters

Name	Description
T
I

Implements

System.IDisposable