Sunbird Portal Documentation
  1. Injectables
  2. LearnerService

File

src/app/modules/core/services/learner/learner.service.ts

Description

Service to provides CRUD methods to make Learner api request by extending DataService.

Extends

DataService

Index

Properties
Methods

Constructor

constructor(config: ConfigService, http: HttpClient)
Defined in src/app/modules/core/services/learner/learner.service.ts:25

constructor

Parameters :
Name Type Optional Description
config ConfigService No

ConfigService reference
http HttpClient No

HttpClient reference

Methods

delete
delete(requestParam: RequestParam)
Inherited from DataService
Defined in DataService:161

for making delete api calls

Parameters :
Name Type Optional Description
requestParam RequestParam No

interface
Returns : Observable<ServerResponse>
get
get(requestParam: RequestParam)
Inherited from DataService
Defined in DataService:82

for making get api calls

Parameters :
Name Type Optional Description
requestParam RequestParam No

interface
Returns : Observable<ServerResponse>
Private getDateDiff
getDateDiff(serverdate)
Inherited from DataService
Defined in DataService:234
Parameters :
Name Optional
serverdate No
Returns : number
Private getHeader
getHeader(headers?)
Inherited from DataService
Defined in DataService:196

for preparing headers

Parameters :
Name Optional
headers Yes
getWithHeaders
getWithHeaders(requestParam: RequestParam)
Inherited from DataService
Defined in DataService:60

for making get api calls which needs headers in response headers are fetched to get server time using Date attribute in header

Parameters :
Name Type Optional Description
requestParam RequestParam No

interface
Returns : Observable<ServerResponse>
patch
patch(requestParam: RequestParam)
Inherited from DataService
Defined in DataService:143

for making patch api calls

Parameters :
Name Type Optional Description
requestParam RequestParam No

interface
Returns : Observable<ServerResponse>
post
post(requestParam: RequestParam)
Inherited from DataService
Defined in DataService:123

for making post api calls

Parameters :
Name Type Optional Description
requestParam RequestParam No

interface
Returns : Observable<ServerResponse>
postWithHeaders
postWithHeaders(requestParam: RequestParam)
Inherited from DataService
Defined in DataService:102

for making post api calls with headers in response object

Parameters :
Name Type Optional Description
requestParam RequestParam No

interface
Returns : Observable<any>
put
put(requestParam: RequestParam)
Inherited from DataService
Defined in DataService:180

for making PUT api calls

Parameters :
Name Type Optional Description
requestParam RequestParam No

interface
Returns : Observable<ServerResponse>

Properties

baseUrl
Type : string
Inherited from DataService
Defined in DataService:17

base Url for lerner api
Public config
Type : ConfigService
Defined in src/app/modules/core/services/learner/learner.service.ts:21

reference of config service.
Public http
Type : HttpClient
Inherited from DataService
Defined in DataService:25

reference of lerner service.
appId
Type : string
Inherited from DataService
Defined in DataService:31

Contains appId
appVersion
Type : string
Inherited from DataService
Defined in DataService:48

Constructor
Parameters :
Name Description
http

HttpClient reference
channelId
Type : string
Inherited from DataService
Defined in DataService:27

Contains channel Id
deviceId
Type : string
Inherited from DataService
Defined in DataService:35

Contains devoce Id
rootOrgId
Type : string
Inherited from DataService
Defined in DataService:23

Contains rootOrg Id
Static sessionId
Type : string
Inherited from DataService
Defined in DataService:19
Static userId
Type : string
Inherited from DataService
Defined in DataService:18 
import { ConfigService } from '../../../shared/services/config/config.service';
import { DataService } from './../data/data.service';
import { Injectable } from '@angular/core';
import { HttpClient } from '@angular/common/http';

/**
 * Service to provides CRUD methods to make Learner api request by extending DataService.
 *
 */
@Injectable({
  providedIn: 'root'
})
export class LearnerService extends DataService {
  /**
   * base Url for lerner api
   */
  baseUrl: string;
  /**
   * reference of config service.
   */
  public config: ConfigService;
  /**
   * reference of lerner service.
   */
  public http: HttpClient;
  /**
   * constructor
   * @param {ConfigService} config ConfigService reference
   * @param {HttpClient} http HttpClient reference
   */
  constructor(config: ConfigService, http: HttpClient) {
    super(http);
    this.config = config;
    this.baseUrl = this.config.urlConFig.URLS.LEARNER_PREFIX;
  }
}

results matching ""

    No results matching ""