angular2-binaryops v0.1.13-beta.1

BinaryOps.io for Angular 2 and Ionic 2

This package contains the client BinaryOps.io client service for Angular 2 and Ionic 2.

Install

in your your angular 2 or ionic 2 project simply run npm install angular2-binaryops --save

In your code you can:

import {BinaryopsService} from 'angular2-binaryops/client';

Remember that as long as you only use one Provider, you'll get the same instance of BinaryopsService, which means you won't need to call login repeatedly.

Important Methods

setApiDetail(environment : string, apiCode: string, apiVersion : string, tenantCode: string) This method needs to be called before any other methods. You can reference the Tenants page in the Dashboard (Sign up for a free account at binaryops.io to obtain the details.

login(username: string, password: string): Observable This method will login on the API. The returned token will be used on all subsequent calls, until login or setUserSecret is called again.

setUserSecret(token: string) Use the authorization token from a user setup with a 'User-Secret authorization' method in the dashboard.

searchDocs(entityCode : string, qry: string):Observable Performs the search the entity. The query is exactly what you would put on the query string in a browser for this request. Please refer to the API Explorer in the dashboard, as well as the docs.binaryops.io

insert(entityName : string, doc: any):Observable Insert a new document. doc is a regular javascript object containing the properties you have defined for the entity in your API.

delete(entityName: string, doc: any):Observable Delete a record. Note that doc (again a javasript object) only needs to contain the _id property for this method to succeed.

update(entityName: string, doc: any):Observable Update a record. _id needs to be present, though not the complete record to be updated needs to be part of doc. You can submit just those values that you want to change.

userMe():Observable Returns a JSON document with your current user information on the API, based on the credentials specified in the login or setUserSecret calls.