pocketbase-csharp-sdk 1.3.0-prerelease

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
This is a prerelease version of pocketbase-csharp-sdk. 
dotnet add package pocketbase-csharp-sdk --version 1.3.0-prerelease                

                    
                

            
NuGet\Install-Package pocketbase-csharp-sdk -Version 1.3.0-prerelease
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="pocketbase-csharp-sdk" Version="1.3.0-prerelease" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add pocketbase-csharp-sdk --version 1.3.0-prerelease                

                    
                

            
#r "nuget: pocketbase-csharp-sdk, 1.3.0-prerelease"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install pocketbase-csharp-sdk as a Cake Addin
#addin nuget:?package=pocketbase-csharp-sdk&version=1.3.0-prerelease&prerelease

// Install pocketbase-csharp-sdk as a Cake Tool
#tool nuget:?package=pocketbase-csharp-sdk&version=1.3.0-prerelease&prerelease

PocketBase C# SDK

This project is currently still under development. It is not recommended to use it in a productive environment. Things can and will change.

Community-developed C# SDK (Multiplatform) for interacting with the PocketBase API

Installation

Nuget

Coming soon

Usage

//create a new Client which connects to your PocketBase-API
var client = new PocketBase("http://127.0.0.1:8090");

//authenticate as a Admin
var admin = await client.Admin.AuthenticateWithPassword("test@test.de", "0123456789");

//or as a User
var user = await client.User.AuthenticateWithPassword("kekw@kekw.com", "0123456789");

//query some data (for example, some restaurants)
//note that each CRUD action requires a data type which inherits from the base class 'ItemBaseModel'.
var restaurantList = await client.Records.ListAsync<Restaurant>("restaurants");

//like this one
class Restaurant : ItemBaseModel
{
    public string? Name { get; set; }
}

Development

Requirements

  • Visual Studio (Community Edition should work just fine)
  • .NET 6/7 SDK

Steps

  1. Clone this repository
git clone https://github.com/PRCV1/pocketbase-csharp-sdk
  1. Open the pocketbase-csharp-sdk.sln with Visual Studio (Community Edition should work just fine)
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on pocketbase-csharp-sdk:

Package Downloads
PocketBaseClient

Client in C# for interacting with a particular PocketBase application, with an ORM to manage Collections and Registries.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.3.0-prerelease 442 5/30/2023
1.2.0-prerelease 122 2/15/2023
1.1.0-prerelease 851 1/2/2023
1.0.0-prerelease 441 12/10/2022