Ngx-ResgridLib is an Angular library used by Resgrid in all of our mobile applications and web applications to interact with the Resgrid API. This library is a foundational element to all of our applications and contains a large cross-section of code used in building our mobile applications which are written in Ionic Framework and Capacitor.
Resgrid is an open-source Computer Aided Dispatch (CAD) solution for first responders, businesses and industrial environments.
Sign up for your free Resgrid Account Today!
- V4 API compatible with the v4 version of the Resgrid API
- RxJS Services for each API utilizing RxJS
- Authentication Library handles the auth flow and storing of the refresh token
# Install the library
npm install @resgrid/ngx-resgridlib --save
import { NgxResgridLibModule } from '@resgrid/ngx-resgridlib';
let getBaseUrl = (): string => {
return 'http://localhost:8081';
}
@NgModule({
declarations: [
AppComponent
],
imports: [
... ,
NgxResgridLibModule.forRoot({
baseApiUrl: getBaseUrl,
apiVersion: 'v4',
clientId: 'test',
googleApiKey: '',
channelUrl: '',
channelHubName: '',
logLevel: 0
}),
],
providers: [],
bootstrap: [ AppComponent ]
})
export class AppModule { }| Setting | Description |
|---|---|
| baseApiUrl | The base URL to talk to the Resgrid API (Services) for our hosted production system this is "https://api.resgrid.com". This is a function that should return the string url to the api without nothing past the hostname and/or port. |
| apiVersion | Version of the API to call, currently only `v4` is supported |
| clientId | Just a name to give to your application using this library |
| googleApiKey | Your Google Map account API key |
| channelUrl | The URL to connect to the SignalR hub for our hosted production system this is "https://api.resgrid.com/signalr" |
| channelHubName | The SignalR hub name to connect to receive events for |
| logLevel | Log level for the library 0 = Debug and above, 1 = Warn and above, 2 = Error only, -1 = Off |