@gapi/angular-client

<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>gapi-angular-client</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">gapi-angular-client</a> <button type="button" class="btn btn-default btn-menu fa fa-bars" 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> <nav> <ul class="list"> <li class="title"> <a href="../index.html">gapi-angular-client</a> </li> <li class="divider"></li> <li class="chapter"> <a data-type="chapter-link" href="../index.html"><span class="fa fa-home"></span>Getting started</a> <ul class="links"> <li class="link"> <a href="../" > <span class="fa fa-th"></span>Overview </a> </li> </ul> </li> <li class="chapter"> <a data-type="chapter-link" href="../modules.html" > <div class="menu-toggler linked" data-toggle="collapse" data-target="#xs-modules-links" > <span class="fa fa-archive"></span> <span class="link-name">Modules</span> <span class="fa fa-angle-down"></span> </div> </a> <ul class="links collapse " id="xs-modules-links" > <li class="link"> <a href="../modules/GapiApolloModule.html" >GapiApolloModule</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#xs-injectables-links" > <span class="fa fa-long-arrow-down"></span> <span>Injectables</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse " id="xs-injectables-links" > <li class="link"> <a href="../injectables/GapiApolloService.html" data-type="entity-link" class="active" >GapiApolloService</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#xs-interfaces-links" > <span class="fa fa-info"></span> <span>Interfaces</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse " id="xs-interfaces-links" > <li class="link"> <a href="../interfaces/GapiApolloClientOptions.html" >GapiApolloClientOptions</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#xs-miscellaneous-links" > <span class="fa fa-cubes"></span> <span>Miscellaneous</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse " id="xs-miscellaneous-links" > <li class="link"> <a href="../miscellaneous/variables.html" data-type="entity-link" >Variables</a> </li> </ul> </li> <li class="chapter"> <a data-type="chapter-link" href="../coverage.html" ><span class="fa fa-tasks"></span>Documentation coverage</a> </li> </ul> </nav> </div> <div class="container-fluid main"> <div class="row main"> <div class="hidden-xs menu"> <nav> <ul class="list"> <li class="title"> <a href="../index.html">gapi-angular-client</a> </li> <li class="divider"></li> <div id="book-search-input" role="search"> <input type="text" placeholder="Type to search"> </div> <li class="chapter"> <a data-type="chapter-link" href="../index.html"><span class="fa fa-home"></span>Getting started</a> <ul class="links"> <li class="link"> <a href="../" > <span class="fa fa-th"></span>Overview </a> </li> </ul> </li> <li class="chapter"> <a data-type="chapter-link" href="../modules.html" > <div class="menu-toggler linked" data-toggle="collapse" data-target="#modules-links" > <span class="fa fa-archive"></span> <span class="link-name">Modules</span> <span class="fa fa-angle-down"></span> </div> </a> <ul class="links collapse " id="modules-links" > <li class="link"> <a href="../modules/GapiApolloModule.html" >GapiApolloModule</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#injectables-links" > <span class="fa fa-long-arrow-down"></span> <span>Injectables</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse " id="injectables-links" > <li class="link"> <a href="../injectables/GapiApolloService.html" data-type="entity-link" class="active" >GapiApolloService</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#interfaces-links" > <span class="fa fa-info"></span> <span>Interfaces</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse " id="interfaces-links" > <li class="link"> <a href="../interfaces/GapiApolloClientOptions.html" >GapiApolloClientOptions</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#miscellaneous-links" > <span class="fa fa-cubes"></span> <span>Miscellaneous</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse " id="miscellaneous-links" > <li class="link"> <a href="../miscellaneous/variables.html" data-type="entity-link" >Variables</a> </li> </ul> </li> <li class="chapter"> <a data-type="chapter-link" href="../coverage.html" ><span class="fa fa-tasks"></span>Documentation coverage</a> </li> </ul> </nav> </div> <div class="content injectable"> <div class="content-data"> <ol class="breadcrumb"> <li>Injectables</li> <li>GapiApolloService</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="active"> <a href="#info" id="info-tab" role="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="info"> <p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/services/apollo.service.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="#graphqlDocs">graphqlDocs</a> </li> <li> <a href="#http">http</a> </li> <li> <a href="#webSocketLink">webSocketLink</a> </li> </ul> </td> </tr> <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="#createClientWithSubscriptions">createClientWithSubscriptions</a> </li> <li> <a href="#createHttpClient">createHttpClient</a> </li> <li> <a href="#importQuery">importQuery</a> </li> <li> <a href="#init">init</a> </li> <li> <a href="#mutation">mutation</a> </li> <li> <a href="#query">query</a> </li> <li> <a href="#resetStore">resetStore</a> </li> <li> <a href="#setAuthorizationToken">setAuthorizationToken</a> </li> <li> <a href="#subscription">subscription</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(apollo: Apollo, httpLink: HttpLink, config: <a href="../interfaces/GapiApolloClientOptions.html">GapiApolloClientOptions</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="17" class="link-to-prism">src/services/apollo.service.ts:17</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> <td>Description</td> </tr> </thead> <tbody> <tr> <td>apollo</td> <td> <code>Apollo</code> </td> <td> </td> <td></td> </tr> <tr> <td>httpLink</td> <td> <code>HttpLink</code> </td> <td> </td> <td></td> </tr> <tr> <td>config</td> <td> <code><a href="../interfaces/GapiApolloClientOptions.html" target="_self" >GapiApolloClientOptions</a></code> </td> <td> </td> <td></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="createClientWithSubscriptions"></a> <span class="name"><b> createClientWithSubscriptions</b><a href="#createClientWithSubscriptions"><span class="fa fa-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>createClientWithSubscriptions()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="68" class="link-to-prism">src/services/apollo.service.ts:68</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="createHttpClient"></a> <span class="name"><b> createHttpClient</b><a href="#createHttpClient"><span class="fa fa-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>createHttpClient()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="51" class="link-to-prism">src/services/apollo.service.ts:51</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="importQuery"></a> <span class="name"><b> importQuery</b><a href="#importQuery"><span class="fa fa-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>importQuery(search: )</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="37" class="link-to-prism">src/services/apollo.service.ts:37</a></div> </td> </tr> <tr> <td class="col-md-4"> <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>search</td> <td> </td> <td> </td> <td></td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="init"></a> <span class="name"><b> init</b><a href="#init"><span class="fa fa-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>init()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="29" class="link-to-prism">src/services/apollo.service.ts:29</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="mutation"></a> <span class="name"><b> mutation</b><a href="#mutation"><span class="fa fa-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>mutation(options: MutationOptions | string, variables?: )</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="99" class="link-to-prism">src/services/apollo.service.ts:99</a></div> </td> </tr> <tr> <td class="col-md-4"> <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>options</td> <td> <code>MutationOptions | string</code> </td> <td> </td> <td></td> </tr> <tr> <td>variables</td> <td> </td> <td> true </td> <td></td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code>Observable<literal type></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="query"></a> <span class="name"><b> query</b><a href="#query"><span class="fa fa-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>query(options: WatchQueryOptions | string, variables?: )</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="106" class="link-to-prism">src/services/apollo.service.ts:106</a></div> </td> </tr> <tr> <td class="col-md-4"> <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>options</td> <td> <code>WatchQueryOptions | string</code> </td> <td> </td> <td></td> </tr> <tr> <td>variables</td> <td> </td> <td> true </td> <td></td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code>Observable<literal type></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="resetStore"></a> <span class="name"><b> resetStore</b><a href="#resetStore"><span class="fa fa-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>resetStore()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="130" class="link-to-prism">src/services/apollo.service.ts:130</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Promise<[]></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="setAuthorizationToken"></a> <span class="name"><b> setAuthorizationToken</b><a href="#setAuthorizationToken"><span class="fa fa-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>setAuthorizationToken(token: <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="64" class="link-to-prism">src/services/apollo.service.ts:64</a></div> </td> </tr> <tr> <td class="col-md-4"> <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>token</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> </td> <td></td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="subscription"></a> <span class="name"><b> subscription</b><a href="#subscription"><span class="fa fa-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>subscription(options: SubscriptionOptions | string)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="123" class="link-to-prism">src/services/apollo.service.ts:123</a></div> </td> </tr> <tr> <td class="col-md-4"> <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>options</td> <td> <code>SubscriptionOptions | string</code> </td> <td> </td> <td></td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code>Observable<literal type></code> </div> <div class="io-description"> </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="graphqlDocs"></a> <span class="name"><b> graphqlDocs</b><a href="#graphqlDocs"><span class="fa fa-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>graphqlDocs: <code></code> </code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="16" class="link-to-prism">src/services/apollo.service.ts:16</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="http"></a> <span class="name"><b> http</b><a href="#http"><span class="fa fa-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>http: <code>HttpLinkHandler</code> </code> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>HttpLinkHandler</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">src/services/apollo.service.ts:15</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="webSocketLink"></a> <span class="name"><b> webSocketLink</b><a href="#webSocketLink"><span class="fa fa-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <code>webSocketLink: <code>WebSocketLink</code> </code> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>WebSocketLink</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="17" class="link-to-prism">src/services/apollo.service.ts:17</a></div> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade tab-source-code" id="source"> <pre class="line-numbers"><code class="language-typescript">import { Injectable, Inject } from '@angular/core'; import { ApolloModule, Apollo, QueryRef } from 'apollo-angular'; import { HttpLinkModule, HttpLink, HttpLinkHandler } from 'apollo-angular-link-http'; import { InMemoryCache } from 'apollo-cache-inmemory'; import { GapiApolloClientOptions, GAPI_APOLLO_MODULE_CONFIG } from '../config'; import { Observable } from 'rxjs/Observable'; import { WatchQueryOptions, ApolloQueryResult, SubscribeToMoreOptions, SubscriptionOptions, MutationOptions } from 'apollo-client'; import { HttpHeaders } from '@angular/common/http'; import { ApolloLink, concat, split } from &#x