# Flutter Client for cockpit CMS
**URL:** https://discourse.getcockpit.com/t/flutter-client-for-cockpit-cms/2292
**Category:** Showcase
**Created:** [February 26, 2022, 3:15pm UTC](https://discourse.getcockpit.com/t/flutter-client-for-cockpit-cms/2292 "2022-02-26T15:15:58Z")
**Posts on this page:** 1
**Page:** 1
### Author:  [@badinga.ulrich](https://discourse.getcockpit.com/u/badinga.ulrich)
#### Post date: [February 26, 2022, 3:15pm UTC](https://discourse.getcockpit.com/t/flutter-client-for-cockpit-cms/2292/1 "2022-02-26T15:15:58Z")
# Flutter Client for cockpit CMS
[](https://pub.dev/packages/cockpit_client)  
## How Install
### Flutter:
```bash
$ flutter pub add cockpit_client
```
### Pubspec.yaml
Add a line like this to your package’s pubspec.yaml
```yaml
dependencies:
cockpit_client: ^1.0.6-b
```
And run if your editor don’t support flutter
```bash
flutter pub get
```
### And import it
Now in your Dart code, add
```dart
import 'package:cockpit_client/cockpit_client.dart';
```
## How Initialize
* * *
### Minimal
```dart
import 'package:cockpit_client/cockpit_client.dart';
// Minimal Initialisation
Cockpit.init(
server: Uri.parse("http://[SERVER HOST]"),
token: "[API TOKEN]",
);
```
### Cocpit is not in root web folder
```dart
import 'package:cockpit_client/cockpit_client.dart';
// Custom path
Cockpit.init(
server: Uri.https("[SERVER HOST]"."/cockpit/folder"),
// OR
//server: Uri.http("[SERVER HOST]"."/cockpit/folder"),
// OR
//server: Uri.parse("http://[SERVER HOST]/cockpit/folder"),
token: "[API TOKEN]",
);
```
### Filter for all request
```dart
import 'package:cockpit_client/cockpit_client.dart';
// never get deleted fields
Cockpit.init(
server: Uri.https("[SERVER HOST]"."/cockpit/folder"),
token: "[API TOKEN]",
defaultFilter : {
r"$or" :[
{ "delete" : {$eq : false} },
{ "delete" : {$eq : null} },
{
"delete" : {
r"$exist" : false
}
}
]
}
);
```
### (Optional) Declare endpoint
```dart
import 'package:cockpit_client/cockpit_client.dart';
// Api declaration
Cockpit.init(
server: Uri.https("[SERVER HOST]"."/cockpit/folder"),
token: "[API TOKEN]",
api : {
// Collection
"myCollection" : {
"collection": "users", // real collection name
"sort": {"login": 1}, // default sort
"fields": [ // get only this fields
"nom",
"prenom",
"parent",
"login",
"enabled",
"_create_by"
]
},
// Form
"myForm" : {
"form": "sendmail" // real form name
},
// Singleton
"mySingleton" : {
"singleton": "configurations" // real singleton name
},
// clollection with virtual properties (map)
"slides" : {
"collection": "collection_name", //collection name in cockpit
"limit": 5, // limit when get data from server
"sort": { // sort results
"_o": 1
},
"fields": [ // fields to gets from the server, other will be ignored
"title",
"image",
"description",
"backgroundColor",
"fontColor"
],
"map": { // change value of a property or set a new property in result object
// you can build string from a template
"image": "{{SERVER}}{{image.path}}",
// or map a property's value to another
"body" : "{{description}}"
},
},
}
);
```
## How Use
### Read data
```dart
// get all elements
List> results = await Cockpit("api_access").find(
cache: Duration(hours : 1), // [optional] cache result
);
// get first element
Map result = await Cockpit("user").findOne(
filter: {
"login" : "root",
"pwd" : "secret",
r"$or": [
{"disable": false},
{
"disable": {
r"$exists": false,
},
},
],
},
);
// get specific element
Map result = await Cockpit("user").get("[My Super ID]");
// get only some fields
Map result = await Cockpit("user").get("[My Super ID]", fields : ["nom", "prenom"]
);
// get one page of elements
List> results = await Cockpit("api_access").find(
limit : 10,
page : 2
); // page start by 0, also set page to 0 for the first page, page to 1 for the second page
// get filtered elements , you can use page, limit, sort, etc. with filter
List> results = await Cockpit("api_access").find(
filter: {
published : true,
},
);
```
### Read undeclared endpoint
To read an undelared endpoint you can just pass the name and use a prefix to specify the type (form, singleton,collection or custom url)
| Prefix | Type | Usage |
| --- | --- | --- |
| \* | Collection | `Cockpit("my_collection")` OR `Cockpit("*my_collection")` |
| @ | Singleton | `Cockpit("@my_singleton")` |
| # | Form | `Cockpit("#my_form")` |
| ! | Custom Cockpit Api | `Cockpit("!my/custom/url")` |
### Save data
```dart
// post data to cockpit (form and collection)
Map data = await Cockpit("api_access").save(
data : {
published : false,
title : "Cool",
description : "I'm juste a test :-p",
},
);
```
### post to a Custom Url
```dart
// post data to a custom cockpit url
Map data = await Cockpit("!/addons/save/gps").get(
data : {
lat : -19.016682,
long : 26.806641,
alt : 15,
},
);
```
## Cockpit urls
### Authenticate user
```dart
Cockpit.authUser('username','xxpasswordxx')
```
### Create / Update user
```dart
Cockpit.saveUser({...}) // user data (user, name, email, active, group)
```
### Get users.
```dart
Cockpit.listUsers([Map filter]) // (optional) you can pass filter
```
### Get assets
```dart
Cockpit.assets([Map filter]) // (optional) you can pass filter
```
### Get thumbnail url
```dart
Cockpit.image(imagePath,
width : width,
height : height,
quality : quality,
domain : domain,
o : o,
base64 : base64,
);
```
### Get all singletons
```javascript
Cockpit.listSingletons()
```
### Get all collections
```javascript
Cockpit.listCollections();
```
### Get collection schema
```javascript
Cockpit("collectionname").schema();
```
### Update collection schema
```javascript
Cockpit("collectionname").updateSchema(fields); // fields is List>
```