<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>CICADA</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" type="image/x-icon" href="../images/favicon.ico"> <link rel="stylesheet" href="../styles/style.css"> </head> <body> <div class="navbar navbar-default navbar-fixed-top visible-xs"> <a href="../" class="navbar-brand">CICADA</a> <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button> </div> <div class="xs-menu menu" id="mobile-menu"> <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu> </div> <div class="container-fluid main"> <div class="row main"> <div class="hidden-xs menu"> <compodoc-menu mode="normal"></compodoc-menu> </div> <!-- START CONTENT --> <div class="content interceptor"> <div class="content-data"> <ol class="breadcrumb"> <li>Interceptors</li> <li>ErrorInterceptor</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="active"> <a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a> </li> <li > <a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a> </li> </ul> <div class="tab-content"> <div class="tab-pane fade active in" id="c-info"> <p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/app/_interceptors/error.interceptor.ts</code> </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>Intercepts and handles errors from outgoing HTTP request. </p> </p> <section> <h3 id="index">Index</h3> <table class="table table-sm table-bordered index-table"> <tbody> <tr> <td class="col-md-4"> <h6><b>Methods</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#intercept">intercept</a> </li> </ul> </td> </tr> </tbody> </table> </section> <section> <h3 id="constructor">Constructor</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <code>constructor(errorDialogService: <a href="../injectables/ErrorDialogService.html">ErrorDialogService</a>, loggingService: <a href="../injectables/LoggingService.html">LoggingService</a>, router: <a href="https://angular.io/api/router/Router" target="_blank">Router</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="21" class="link-to-prism">src/app/_interceptors/error.interceptor.ts:21</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Initialization of the error interceptor.</p> </div> <div> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>errorDialogService</td> <td> <code><a href="../injectables/ErrorDialogService.html" target="_self" >ErrorDialogService</a></code> </td> <td> No </td> <td> <code><ul> <li>A service that provides a dialog box for displaying errors to the user.</li> </ul> </code> </td> </tr> <tr> <td>loggingService</td> <td> <code><a href="../injectables/LoggingService.html" target="_self" >LoggingService</a></code> </td> <td> No </td> <td> <code><ul> <li>A service that provides logging capabilities.</li> </ul> </code> </td> </tr> <tr> <td>router</td> <td> <code><a href="https://angular.io/api/router/Router" target="_blank" >Router</a></code> </td> <td> No </td> <td> <code><ul> <li>A service that provides navigation among views and URL manipulation capabilities.</li> </ul> </code> </td> </tr> </tbody> </table> </div> </td> </tr> </tbody> </table> </section> <section> <h3 id="methods"> Methods </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="intercept"></a> <span class="name"> <b> intercept </b> <a href="#intercept"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>intercept(request: HttpRequest<unknown>, next: <a href="https://angular.io/api/common/http/HttpHandler" target="_blank">HttpHandler</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="42" class="link-to-prism">src/app/_interceptors/error.interceptor.ts:42</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Intercepts HTTP requests.</p> </div> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>request</td> <td> <code>HttpRequest<unknown></code> </td> <td> No </td> <td> <ul> <li>An outgoing HTTP request with an optional typed body.</li> </ul> </td> </tr> <tr> <td>next</td> <td> <code><a href="https://angular.io/api/common/http/HttpHandler" target="_blank" >HttpHandler</a></code> </td> <td> No </td> <td> <ul> <li>The next HTTP handler or the outgoing request dispatcher.</li> </ul> </td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code>Observable<HttpEvent<unknown>></code> </div> <div class="io-description"> <p>The error caught from the request.</p> </div> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade tab-source-code" id="c-source"> <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { HttpErrorResponse, HttpEvent, HttpHandler, HttpInterceptor, HttpRequest, } from '@angular/common/http'; import { Injectable } from '@angular/core'; import { Router } from '@angular/router'; // Third party imports import { Observable, throwError } from 'rxjs'; import { catchError } from 'rxjs/operators'; // Application imports import { ErrorDialogService, LoggingService } from '@app/_services'; /** Intercepts and handles errors from outgoing HTTP request. */ @Injectable() export class ErrorInterceptor implements HttpInterceptor { /** * Initialization of the error interceptor. * * @param errorDialogService - A service that provides a dialog box for displaying errors to the user. * @param loggingService - A service that provides logging capabilities. * @param router - A service that provides navigation among views and URL manipulation capabilities. */ constructor( private errorDialogService: ErrorDialogService, private loggingService: LoggingService, private router: Router ) {} /** * Intercepts HTTP requests. * * @param request - An outgoing HTTP request with an optional typed body. * @param next - The next HTTP handler or the outgoing request dispatcher. * @returns The error caught from the request. */ intercept(request: HttpRequest<unknown>, next: HttpHandler): Observable<HttpEvent<unknown>> { return next.handle(request).pipe( catchError((err: HttpErrorResponse) => { let errorMessage: string; if (err.error instanceof ErrorEvent) { // A client-side or network error occurred. Handle it accordingly. errorMessage = `An error occurred: ${err.error.message}`; } else { // The backend returned an unsuccessful response code. // The response body may contain clues as to what went wrong. errorMessage = `Backend returned code ${err.status}, body was: ${JSON.stringify( err.error )}`; } this.loggingService.sendErrorLevelMessage(errorMessage, this, { error: err }); switch (err.status) { case 401: // unauthorized this.router.navigateByUrl('/auth').then(); break; case 403: // forbidden alert('Access to resource is not allowed!'); break; } // Return an observable with a user-facing error message. return throwError(err); }) ); } } </code></pre> </div> </div> </div><div class="search-results"> <div class="has-results"> <h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> </div> </div> </div> <!-- END CONTENT --> </div> </div> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 1; var COMPODOC_CURRENT_PAGE_CONTEXT = 'interceptor'; var COMPODOC_CURRENT_PAGE_URL = 'ErrorInterceptor.html'; var MAX_SEARCH_RESULTS = 15; </script> <script src="../js/libs/custom-elements.min.js"></script> <script src="../js/libs/lit-html.js"></script> <!-- Required to polyfill modern browsers as code is ES5 for IE... --> <script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script> <script src="../js/menu-wc.js" defer></script> <script src="../js/libs/bootstrap-native.js"></script> <script src="../js/libs/es6-shim.min.js"></script> <script src="../js/libs/EventDispatcher.js"></script> <script src="../js/libs/promise.min.js"></script> <script src="../js/libs/zepto.min.js"></script> <script src="../js/compodoc.js"></script> <script src="../js/tabs.js"></script> <script src="../js/menu.js"></script> <script src="../js/libs/clipboard.min.js"></script> <script src="../js/libs/prism.js"></script> <script src="../js/sourceCode.js"></script> <script src="../js/search/search.js"></script> <script src="../js/search/lunr.min.js"></script> <script src="../js/search/search-lunr.js"></script> <script src="../js/search/search_index.js"></script> <script src="../js/lazy-load-graphs.js"></script> </body> </html>