BFast

BFast client sdk for flutter. Always use latest version to stay up to date. Refer to BFastProject for more documentation and learn more.

Get Started

Make sure you have your BFast project up and running. Login to your BFast project and create a client apiKey to be used with SDK.

Initiate Sdk

After install sdk navigate to your main class and add the following code

// some codes and imports

void main(){
    runapp(MyApp());

    BFast().init(serverUrl: '<YOUR_BFAST_SERVER_URL>', apiKey: '<API_KEY>' ); // add this codes
}

// some other codes

NOTE

  • <YOUR_BFAST_SERVER_URL> This is a full hostname with port on which your BFast application is running for example https://demo.bfast:8000. Don't include / at the end f your serverUrl

  • <API_KEY> Api key as you define it to your project

BFast Domain

This section handle data manipulation of BFast domains

Save data to your domain

Domain is a schema or model you define to your BFast project, once build and deploy you can save data through various ways as follow

var product = BFast().domain('products');
product
    .set('name', 'XPS 13')
    .set('price', 1000)
    .save()
    .then((value){
        // product added
    }).catch((reason){
        // handle errors
    });

Or you can do this way

var product = BFast().domain('products');
product.set('name', 'XPS 13');
product.set('price', 1000);
product.save().then((value){
    // product added
}).catch((reason){
    // handle errors
});

Or you can do like this

var product = BFast().domain('products');
product.setValues({
    'name': 'XPS 13',
    'price': 1000
}).save().then((value){
    // product added
}).catch((reason){
    // handle errors
});

Response of a save method will be an object like

{message: "<RESPONSE_MESSAGE>"}

Get many domain in pagination

You can retrive domains from your bfast project as follow.

var product = BFast().domain('products');
product.many().then((value){
    // your logics to handle data
}).catch((reason){
    // handle errors
});

This will return first 20 domain objects from your bfast projects as a default pagination. Or you can pass optinal params as follow

var product = BFast().domain('products');
product.many({
    "size": 100, // data returned size [option]
    "page": 0, // starting page [option]
    "order": "name" // order results by name [option]
}).then((value){
    // your logics to handle data
}).catch((reason){
    // handle errors
});

When request is succesfull, response will be of the following format. Note DOMAIN_NAME mean the name of the domain you request data in this example products

{
    [DOMAIN_NAME]: Array,
    page: Object,
    links: Object
}

page property contain information abount pagination of data, links contain information on how to navigate between data and propert DOMAIN_NAME contain array of request data

Get a single object of a domain

To get a single object of a domain we can either use link of that object or its objectId.

  • By using link
var product = BFast().domain('products');
product.one(link: '<OBJECT_LINK>').then((value){
    // your logics to handle object data  
}).catch((reason){
    //  handle errors
});
  • By using objectId/id
var product = BFast().domain('products');
product.one(id: '<OBJECT_ID>').then((value){
    // your logics to handle object data  
}).catch((reason){
    //  handle errors
});
  • When pass both link and id. link will be used instead of id
var product = BFast().domain('products');
product.one(link: '<OBJECT_LINK>', id: '<OBJECT_ID>').then((value){
    // your logics to handle object data  
}).catch((reason){
    //  handle errors
});

Response will be of the following format

{
    [DOMAIN_NAME]: Object
}

Update Domain

To update a single object of a domain we can either use link of that object or its objectId.

  • By using link
var product = BFast().domain('products');
product.set('name', 'XPS 15');
product.set('price', 3000);
product.update(link: '<OBJECT_LINK>').then((value){
    // object updated
}).catch((reason){
    //  handle errors
});
  • By using objectId/id
var product = BFast().domain('products');
product.set('name', 'XPS 15');
product.set('price', 3000);
product.update(id: '<OBJECT_ID>').then((value){
    // object updated
}).catch((reason){
    //  handle errors
});
  • When pass both link and id. link will be used instead of id
var product = BFast().domain('products');
product.set('name', 'XPS 15');
product.set('price', 3000);
product.update(link: '<OBJECT_LINK>', id: '<OBJECT_ID>').then((value){
    // object updated  
}).catch((reason){
    //  handle errors
});

Response will be of the following format

{
    message: <MESSAGE_FROM_SERVER>
}

Delete Domain

To delete a domain we can either use link of that object or its objectId.

  • By using link
var product = BFast().domain('products');
product.delete(link: '<OBJECT_LINK>').then((value){
    // object deleted
}).catch((reason){
    //  handle errors
});
  • By using objectId/id
var product = BFast().domain('products');
product.delete(id: '<OBJECT_ID>').then((value){
    // object deleted  
}).catch((reason){
    //  handle errors
});
  • When pass both link and id. link will be used instead of id
var product = BFast().domain('products');
product.delete(link: '<OBJECT_LINK>', id: '<OBJECT_ID>').then((value){
    // object deleted
}).catch((reason){
    //  handle errors
});

Response will be of the following format

{
    message: <MESSAGE_FROM_SERVER>
}

Call a query from BFast project

You can call a query defined to your domain from BFast console/project as follow. Let say we define a query in our domain called findAllByName

var product = BFast().domain('products');
product.search('findAllByName',{
    "name": "XPS 13"
}).then((value){
    // your logic to handle results
}).catch((reason){
    // handle error
})

When request is succesfull, response will be of the following format. Note DOMAIN_NAME mean the name of the domain you request data in this example products

{
    [DOMAIN_NAME]: dynamic, // depend on return of query
    page: Object, // option, can be null
    links: Object // option, can be null
}

page property contain information abount pagination of data, links contain information on how to navigate between data and propert DOMAIN_NAME contain array of request data

Pagination support

You can navigate forward and backward through your data pr jump to a specific page by as follow

var product = BFast().domain('products');
product.navigate('<LINK_OF_NEXT_DATA>').then((value){
    // handle next data
}).catch((reason){
    // handle errors
});

When request is succesfull, response will be of the following format. Note DOMAIN_NAME mean the name of the domain you request data in this example products

{
    [DOMAIN_NAME]: Array,
    page: Object,
    links: Object
}

page property contain information abount pagination of data, links contain information on how to navigate between data and propert DOMAIN_NAME contain array of request data

BFast Function

BFast project support function as a service or cloud function which you can call it as follow

BFast().fun('hello').run().then((value){
    // handle your function results
}).catch((reason){
    // handle erros
})

You can pass body to your function to as follow

BFast().fun('hello').run({
    "name": "Joshua"
}).tne((value){
    // handle your function results
}).catch((reason){
    // handle errors
});

Response will be as you return from your function

Libraries

bfast
configuration
domain
domain
function
function