ha-ngx-api
v1.0.46
Published
Access to High Attendance API as an Angular library
Downloads
57
Maintainers
Readme
HaNgxApi
This is an API library for Angular 9+. It communicates with the High Attendance backend.
This library was generated with Angular CLI version 9.1.9.
Usage
Installation
npm install ha-ngx-api
Dependecies and customization
- Import
HaNgxApiModule
module in the app module - Configure the API URL, company ID, event ID and token
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { environment } from '../environments/environment';
import { AppRoutingModule } from './app-routing.module';
import { AppComponent } from './app.component';
import { HaNgxApiModule } from 'ha-ngx-api';
@NgModule({
HaNgxApiModule.forRoot({
baseUrl: environment.baseUrl,
token: environment.token,
}),
})
export class AppModule { }
Example use in component
import { Component, OnInit } from '@angular/core';
import { environment } from '../../environments/environment';
import { SessionDataProviderService,
EventDataProviderService,
Session,
SessionGroup,
Speaker,
Track } from 'ha-ngx-api';
@Component({
selector: 'app-home',
templateUrl: './home.component.html',
styleUrls: ['./home.component.scss']
})
export class HomeComponent implements OnInit {
constructor(private sessionDataProvider: SessionDataProviderService,
private eventDataProvider: EventDataProviderService) { }
ngOnInit(): void {
// Get mock data by passing "true" as the last parameter in the setup() function
// this.sessionDataProvider.setup(environment.eventId, environment.companyId, true);
this.sessionDataProvider.setup(environment.eventId, environment.companyId);
}
private getSessionGroups() {
this.sessionDataProvider.sessionGroups().subscribe((sessions: SessionGroup[]) => {
console.log('sessionGroups: ', sessions);
});
}
private getEventGroups() {
const companyId = '98';
const companyToken = 'uPclmJR';
const type = 'all';
this.eventDataProvider.setupEvents(companyId, companyToken, type);
this.eventDataProvider.eventGroups().subscribe((events: EventGroup[]) => {
console.log('eventGroups: ', events);
},
(error) => {
console.log(error);
});
}
}
Code scaffolding
Run ng generate component component-name --project HaNgxApi
to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project HaNgxApi
.
Note: Don't forget to add
--project HaNgxApi
or else it will be added to the default project in yourangular.json
file.
Build
Run ng build HaNgxApi
to build the project. The build artifacts will be stored in the dist/
directory.
Publishing
After building your library with ng build HaNgxApi
, go to the dist folder cd dist/ha-ngx-api
and run npm publish
.
Running unit tests
Run ng test HaNgxApi
to execute the unit tests via Karma.
Further help
To get more help on the Angular CLI use ng help
or go check out the Angular CLI README.