Skip to content
Snippets Groups Projects
ApiError.html 11.9 KiB
Newer Older
  • Learn to ignore specific revisions
  • <!doctype html>
    <html class="no-js" lang="">
        <head>
            <meta charset="utf-8">
            <meta http-equiv="x-ua-compatible" content="ie=edge">
            <title>itc-ng documentation</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">itc-ng documentation</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 class">
                       <div class="content-data">
    
    
    
    
    
    
    
    
    
    
    
    <ol class="breadcrumb">
      <li>Classes</li>
      <li>ApiError</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/app.interfaces.ts</code>
            </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>Properties</b></h6>
                        </td>
                    </tr>
                    <tr>
                        <td class="col-md-4">
                            <ul class="index-list">
                                <li>
                                    <a href="#code">code</a>
                                </li>
                                <li>
                                    <a href="#info">info</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(code: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>, info: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
                        </td>
                    </tr>
                            <tr>
                                <td class="col-md-4">
                                    <div class="io-line">Defined in <a href="" data-line="59" class="link-to-prism">src/app/app.interfaces.ts:59</a></div>
                                </td>
                            </tr>
    
                    <tr>
                        <td class="col-md-4">
                                <div>
                                        <b>Parameters :</b>
                                        <table class="params">
                                            <thead>
                                                <tr>
                                                    <td>Name</td>
                                                        <td>Type</td>
                                                    <td>Optional</td>
                                                </tr>
                                            </thead>
                                            <tbody>
                                                    <tr>
                                                            <td>code</td>
                                                      
                                                            <td>
                                                                            <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
                                                            </td>
                                                      
                                                        <td>
                                                                No
                                                        </td>
                                                        
                                                    </tr>
                                                    <tr>
                                                            <td>info</td>
                                                      
                                                            <td>
                                                                            <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
                                                            </td>
                                                      
                                                        <td>
                                                                No
                                                        </td>
                                                        
                                                    </tr>
                                            </tbody>
                                        </table>
                                </div>
                        </td>
                    </tr>
                </tbody>
            </table>
    </section>
    
                <section>
        
            <h3 id="inputs">
                Properties
            </h3>
            <table class="table table-sm table-bordered">
                <tbody>
                    <tr>
                        <td class="col-md-4">
                            <a name="code"></a>
                            <span class="name">
                                <b>
                                code</b>
                                <a href="#code"><span class="icon ion-ios-link"></span></a>
                            </span>
                        </td>
                    </tr>
                        <tr>
                            <td class="col-md-4">
                                <i>Type : </i>        <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
    
                            </td>
                        </tr>
                            <tr>
                                <td class="col-md-4">
                                        <div class="io-line">Defined in <a href="" data-line="57" class="link-to-prism">src/app/app.interfaces.ts:57</a></div>
                                </td>
                            </tr>
    
    
                </tbody>
            </table>
            <table class="table table-sm table-bordered">
                <tbody>
                    <tr>
                        <td class="col-md-4">
                            <a name="info"></a>
                            <span class="name">
                                <b>
                                info</b>
                                <a href="#info"><span class="icon ion-ios-link"></span></a>
                            </span>
                        </td>
                    </tr>
                        <tr>
                            <td class="col-md-4">
                                <i>Type : </i>        <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
    
                            </td>
                        </tr>
                            <tr>
                                <td class="col-md-4">
                                        <div class="io-line">Defined in <a href="" data-line="59" class="link-to-prism">src/app/app.interfaces.ts:59</a></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">export enum AuthFlagType {
      CODE_REQUIRED &#x3D; &#x27;codeRequired&#x27;,
      PENDING &#x3D; &#x27;pending&#x27;,
      EXPIRED &#x3D; &#x27;expired&#x27;
    }
    
    export enum AuthAccessKeyType {
      WORKSPACE_ADMIN &#x3D; &#x27;workspaceAdmin&#x27;,
      SUPER_ADMIN &#x3D; &#x27;superAdmin&#x27;,
      TEST &#x3D; &#x27;test&#x27;,
      WORKSPACE_MONITOR &#x3D; &#x27;workspaceMonitor&#x27;,
      TEST_GROUP_MONITOR &#x3D; &#x27;testGroupMonitor&#x27;
    }
    
    export interface AccessType {
      [key: string]: string[];
    }
    
    export interface AuthData {
      token: string;
      displayName: string;
      customTexts: KeyValuePairs;
      flags: AuthFlagType[];
      access: AccessType;
    }
    
    export interface WorkspaceData {
      id: string;
      name: string;
      role: &#x27;RW&#x27; | &#x27;RO&#x27; | &#x27;n.d.&#x27;;
    }
    
    export interface AccessObject {
      id: string;
      name: string;
    }
    
    export interface BookletData {
      id: string;
      label: string;
      running: boolean;
      locked: boolean;
      xml?: string; // in monitor
    }
    
    export interface KeyValuePairs {
      [K: string]: string;
    }
    
    export interface AppError {
      label: string;
      description: string;
      category: &#x27;WARNING&#x27; | &#x27;FATAL&#x27; | &#x27;PROBLEM&#x27;;
    }
    
    export class ApiError {
      code: number;
    
      info: string;
    
      constructor(code: number, info &#x3D; &#x27;&#x27;) {
        this.code &#x3D; code;
        this.info &#x3D; info;
      }
    }
    
    export interface SysCheckInfo {
      workspaceId: string;
      name: string;
      label: string;
      description: string;
    }
    </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 = 'class';
                var COMPODOC_CURRENT_PAGE_URL = 'ApiError.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>