From 73550680570630fd475a148fea9db83d172afc49 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Poullain?= Date: Thu, 5 Dec 2019 09:18:00 +0100 Subject: [PATCH] [Docs] Update API reference --- ...ract_provider_service_.abstractprovider.md | 24 +++++++-------- ...ct_provider_service_.authorizationerror.md | 14 ++++----- ...act_provider_service_.invalidstateerror.md | 24 +++++++++++++-- .../_abstract_provider_service_.tokenerror.md | 10 +++---- ...book_provider_service_.facebookprovider.md | 30 +++++++++---------- ...acebook_provider_service_.userinfoerror.md | 10 +++---- ...google_provider_service_.googleprovider.md | 26 ++++++++-------- ...oogle_provider_service_.invalidjwterror.md | 6 ++-- ...abstract_provider_service_.socialtokens.md | 4 +-- ...act_provider_service_.userinfoandtokens.md | 4 +-- ...ok_provider_service_.facebookauthparams.md | 2 +- ...rovider_service_.facebookuserinfoparams.md | 2 +- ...ogle_provider_service_.googleauthparams.md | 16 +++++----- .../modules/_abstract_provider_service_.md | 2 +- 14 files changed, 96 insertions(+), 78 deletions(-) diff --git a/docs/api/social/classes/_abstract_provider_service_.abstractprovider.md b/docs/api/social/classes/_abstract_provider_service_.abstractprovider.md index a46806907f..a11dc4b8cf 100644 --- a/docs/api/social/classes/_abstract_provider_service_.abstractprovider.md +++ b/docs/api/social/classes/_abstract_provider_service_.abstractprovider.md @@ -58,7 +58,7 @@ Abstract class that any social provider must inherit from. **● authEndpoint**: *`string`* -*Defined in [abstract-provider.service.ts:117](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L117)* +*Defined in [abstract-provider.service.ts:133](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L133)* URL of the authorization endpoint from which we retrieve an authorization code. @@ -75,7 +75,7 @@ ___ **● configInstance**: *`Config`* -*Defined in [abstract-provider.service.ts:90](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L90)* +*Defined in [abstract-provider.service.ts:106](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L106)* ___ @@ -84,7 +84,7 @@ ___ **● configPaths**: *`object`* -*Defined in [abstract-provider.service.ts:104](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L104)* +*Defined in [abstract-provider.service.ts:120](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L120)* Configuration paths from which the client ID, client secret and redirect URI must be retrieved. @@ -109,7 +109,7 @@ ___ **● defaultScopes**: *`string`[]* = [] -*Defined in [abstract-provider.service.ts:135](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L135)* +*Defined in [abstract-provider.service.ts:151](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L151)* Default scopes requested by the social provider. @@ -124,7 +124,7 @@ ___ **● scopeSeparator**: *`string`* = " " -*Defined in [abstract-provider.service.ts:144](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L144)* +*Defined in [abstract-provider.service.ts:160](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L160)* Character used to separate the scopes in the URL. @@ -139,7 +139,7 @@ ___ **● tokenEndpoint**: *`string`* -*Defined in [abstract-provider.service.ts:126](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L126)* +*Defined in [abstract-provider.service.ts:142](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L142)* URL of the token endpoint from which we retrieve an access token. @@ -159,7 +159,7 @@ ___ **get config**(): `object` -*Defined in [abstract-provider.service.ts:146](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L146)* +*Defined in [abstract-provider.service.ts:162](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L162)* **Returns:** `object` @@ -173,7 +173,7 @@ ___ ▸ **getState**(): `Promise`<`string`> -*Defined in [abstract-provider.service.ts:268](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L268)* +*Defined in [abstract-provider.service.ts:284](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L284)* **Returns:** `Promise`<`string`> @@ -184,7 +184,7 @@ ___ ▸ **getTokens**(ctx: *`Context`*): `Promise`<[SocialTokens](../interfaces/_abstract_provider_service_.socialtokens.md)> -*Defined in [abstract-provider.service.ts:219](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L219)* +*Defined in [abstract-provider.service.ts:235](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L235)* Function to use in the controller method that handles the provider redirection. @@ -208,7 +208,7 @@ ___ ▸ **getUserInfo**<`UserInfo`>(ctx: *`Context`*, params?: *[UserInfoParameters]()*): `Promise`<[UserInfoAndTokens](../interfaces/_abstract_provider_service_.userinfoandtokens.md)<`UserInfo`>> -*Defined in [abstract-provider.service.ts:262](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L262)* +*Defined in [abstract-provider.service.ts:278](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L278)* Function to use in the controller method that handles the provider redirection. @@ -238,7 +238,7 @@ ___ ▸ **getUserInfoFromTokens**(tokens: *[SocialTokens](../interfaces/_abstract_provider_service_.socialtokens.md)*, params?: *[UserInfoParameters]()*): `any` -*Defined in [abstract-provider.service.ts:165](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L165)* +*Defined in [abstract-provider.service.ts:181](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L181)* Retrieve user information from the tokens returned by the authorization server. @@ -265,7 +265,7 @@ ___ ▸ **redirect**(__namedParameters?: *`object`*, params?: *[AuthParameters]()*): `Promise`<`HttpResponseRedirect`> -*Defined in [abstract-provider.service.ts:175](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L175)* +*Defined in [abstract-provider.service.ts:191](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L191)* Returns an HttpResponseRedirect object to use to redirect the user to the social provider's authorization page. diff --git a/docs/api/social/classes/_abstract_provider_service_.authorizationerror.md b/docs/api/social/classes/_abstract_provider_service_.authorizationerror.md index 4b228dd17a..0c29d504d8 100644 --- a/docs/api/social/classes/_abstract_provider_service_.authorizationerror.md +++ b/docs/api/social/classes/_abstract_provider_service_.authorizationerror.md @@ -42,7 +42,7 @@ Error thrown if the authorization server returns an error. ⊕ **new AuthorizationError**(error: *`string`*, errorDescription?: *`undefined` \| `string`*, errorUri?: *`undefined` \| `string`*): [AuthorizationError](_abstract_provider_service_.authorizationerror.md) -*Defined in [abstract-provider.service.ts:50](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L50)* +*Defined in [abstract-provider.service.ts:56](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L56)* **Parameters:** @@ -64,7 +64,7 @@ ___ **● error**: *`string`* -*Defined in [abstract-provider.service.ts:52](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L52)* +*Defined in [abstract-provider.service.ts:58](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L58)* ___ @@ -73,7 +73,7 @@ ___ **● errorDescription**: *`undefined` \| `string`* -*Defined in [abstract-provider.service.ts:53](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L53)* +*Defined in [abstract-provider.service.ts:59](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L59)* ___ @@ -82,7 +82,7 @@ ___ **● errorUri**: *`undefined` \| `string`* -*Defined in [abstract-provider.service.ts:54](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L54)* +*Defined in [abstract-provider.service.ts:60](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L60)* ___ @@ -100,11 +100,11 @@ ___ ### name -**● name**: *`string`* +**● name**: *"AuthorizationError"* = "AuthorizationError" -*Inherited from Error.name* +*Overrides Error.name* -*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/social/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:963* +*Defined in [abstract-provider.service.ts:56](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L56)* ___ diff --git a/docs/api/social/classes/_abstract_provider_service_.invalidstateerror.md b/docs/api/social/classes/_abstract_provider_service_.invalidstateerror.md index fb5331fbd1..e3af97f5de 100644 --- a/docs/api/social/classes/_abstract_provider_service_.invalidstateerror.md +++ b/docs/api/social/classes/_abstract_provider_service_.invalidstateerror.md @@ -18,6 +18,10 @@ Error thrown if the state does not match. ## Index +### Constructors + +* [constructor](_abstract_provider_service_.invalidstateerror.md#constructor) + ### Properties * [message](_abstract_provider_service_.invalidstateerror.md#message) @@ -27,6 +31,20 @@ Error thrown if the state does not match. --- +## Constructors + + + +### constructor + +⊕ **new InvalidStateError**(): [InvalidStateError](_abstract_provider_service_.invalidstateerror.md) + +*Defined in [abstract-provider.service.ts:42](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L42)* + +**Returns:** [InvalidStateError](_abstract_provider_service_.invalidstateerror.md) + +___ + ## Properties @@ -44,11 +62,11 @@ ___ ### name -**● name**: *`string`* +**● name**: *"InvalidStateError"* = "InvalidStateError" -*Inherited from Error.name* +*Overrides Error.name* -*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/social/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:963* +*Defined in [abstract-provider.service.ts:42](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L42)* ___ diff --git a/docs/api/social/classes/_abstract_provider_service_.tokenerror.md b/docs/api/social/classes/_abstract_provider_service_.tokenerror.md index ffb47292fd..8e31ab2e45 100644 --- a/docs/api/social/classes/_abstract_provider_service_.tokenerror.md +++ b/docs/api/social/classes/_abstract_provider_service_.tokenerror.md @@ -40,7 +40,7 @@ Error thrown if the token endpoint does not return a 2xx response. ⊕ **new TokenError**(error: *`any`*): [TokenError](_abstract_provider_service_.tokenerror.md) -*Defined in [abstract-provider.service.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L67)* +*Defined in [abstract-provider.service.ts:79](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L79)* **Parameters:** @@ -60,7 +60,7 @@ ___ **● error**: *`any`* -*Defined in [abstract-provider.service.ts:68](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L68)* +*Defined in [abstract-provider.service.ts:81](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L81)* ___ @@ -78,11 +78,11 @@ ___ ### name -**● name**: *`string`* +**● name**: *"TokenError"* = "TokenError" -*Inherited from Error.name* +*Overrides Error.name* -*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/social/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:963* +*Defined in [abstract-provider.service.ts:79](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L79)* ___ diff --git a/docs/api/social/classes/_facebook_provider_service_.facebookprovider.md b/docs/api/social/classes/_facebook_provider_service_.facebookprovider.md index 7b3359e617..449260e9d7 100644 --- a/docs/api/social/classes/_facebook_provider_service_.facebookprovider.md +++ b/docs/api/social/classes/_facebook_provider_service_.facebookprovider.md @@ -51,7 +51,7 @@ Facebook social provider. *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[authEndpoint](_abstract_provider_service_.abstractprovider.md#authendpoint)* -*Defined in [facebook-provider.service.ts:38](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L38)* +*Defined in [facebook-provider.service.ts:43](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L43)* ___ @@ -62,7 +62,7 @@ ___ *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[configInstance](_abstract_provider_service_.abstractprovider.md#configinstance)* -*Defined in [abstract-provider.service.ts:90](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L90)* +*Defined in [abstract-provider.service.ts:106](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L106)* ___ @@ -73,7 +73,7 @@ ___ *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[defaultScopes](_abstract_provider_service_.abstractprovider.md#defaultscopes)* -*Defined in [facebook-provider.service.ts:44](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L44)* +*Defined in [facebook-provider.service.ts:49](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L49)* ___ @@ -82,7 +82,7 @@ ___ **● fields**: *`string`[]* = [ 'id', 'name', 'email' ] -*Defined in [facebook-provider.service.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L42)* +*Defined in [facebook-provider.service.ts:47](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L47)* ___ @@ -93,7 +93,7 @@ ___ *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[scopeSeparator](_abstract_provider_service_.abstractprovider.md#scopeseparator)* -*Defined in [abstract-provider.service.ts:144](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L144)* +*Defined in [abstract-provider.service.ts:160](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L160)* Character used to separate the scopes in the URL. @@ -110,7 +110,7 @@ ___ *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[tokenEndpoint](_abstract_provider_service_.abstractprovider.md#tokenendpoint)* -*Defined in [facebook-provider.service.ts:39](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L39)* +*Defined in [facebook-provider.service.ts:44](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L44)* ___ @@ -119,7 +119,7 @@ ___ **● userInfoEndpoint**: *`string`* = "https://graph.facebook.com/v5.0/me" -*Defined in [facebook-provider.service.ts:40](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L40)* +*Defined in [facebook-provider.service.ts:45](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L45)* ___ @@ -133,7 +133,7 @@ ___ *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[getTokens](_abstract_provider_service_.abstractprovider.md#gettokens)* -*Defined in [abstract-provider.service.ts:219](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L219)* +*Defined in [abstract-provider.service.ts:235](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L235)* Function to use in the controller method that handles the provider redirection. @@ -159,7 +159,7 @@ ___ *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[getUserInfo](_abstract_provider_service_.abstractprovider.md#getuserinfo)* -*Defined in [abstract-provider.service.ts:262](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L262)* +*Defined in [abstract-provider.service.ts:278](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L278)* Function to use in the controller method that handles the provider redirection. @@ -191,7 +191,7 @@ ___ *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[getUserInfoFromTokens](_abstract_provider_service_.abstractprovider.md#getuserinfofromtokens)* -*Defined in [facebook-provider.service.ts:46](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L46)* +*Defined in [facebook-provider.service.ts:51](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L51)* **Parameters:** @@ -211,7 +211,7 @@ ___ *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[redirect](_abstract_provider_service_.abstractprovider.md#redirect)* -*Defined in [abstract-provider.service.ts:175](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L175)* +*Defined in [abstract-provider.service.ts:191](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L191)* Returns an HttpResponseRedirect object to use to redirect the user to the social provider's authorization page. @@ -242,7 +242,7 @@ ___ *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[configPaths](_abstract_provider_service_.abstractprovider.md#configpaths)* -*Defined in [facebook-provider.service.ts:32](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L32)* +*Defined in [facebook-provider.service.ts:37](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L37)* @@ -250,7 +250,7 @@ ___ **● clientId**: *`string`* = "settings.social.facebook.clientId" -*Defined in [facebook-provider.service.ts:33](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L33)* +*Defined in [facebook-provider.service.ts:38](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L38)* ___ @@ -259,7 +259,7 @@ ___ **● clientSecret**: *`string`* = "settings.social.facebook.clientSecret" -*Defined in [facebook-provider.service.ts:34](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L34)* +*Defined in [facebook-provider.service.ts:39](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L39)* ___ @@ -268,7 +268,7 @@ ___ **● redirectUri**: *`string`* = "settings.social.facebook.redirectUri" -*Defined in [facebook-provider.service.ts:35](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L35)* +*Defined in [facebook-provider.service.ts:40](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L40)* ___ diff --git a/docs/api/social/classes/_facebook_provider_service_.userinfoerror.md b/docs/api/social/classes/_facebook_provider_service_.userinfoerror.md index f26d1c7adc..d032d02170 100644 --- a/docs/api/social/classes/_facebook_provider_service_.userinfoerror.md +++ b/docs/api/social/classes/_facebook_provider_service_.userinfoerror.md @@ -32,7 +32,7 @@ ⊕ **new UserInfoError**(error: *`any`*): [UserInfoError](_facebook_provider_service_.userinfoerror.md) -*Defined in [facebook-provider.service.ts:18](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L18)* +*Defined in [facebook-provider.service.ts:19](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L19)* **Parameters:** @@ -52,7 +52,7 @@ ___ **● error**: *`any`* -*Defined in [facebook-provider.service.ts:19](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L19)* +*Defined in [facebook-provider.service.ts:21](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L21)* ___ @@ -70,11 +70,11 @@ ___ ### name -**● name**: *`string`* +**● name**: *"UserInfoError"* = "UserInfoError" -*Inherited from Error.name* +*Overrides Error.name* -*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/social/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:963* +*Defined in [facebook-provider.service.ts:19](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L19)* ___ diff --git a/docs/api/social/classes/_google_provider_service_.googleprovider.md b/docs/api/social/classes/_google_provider_service_.googleprovider.md index a1aa841cbf..6c2b76a58b 100644 --- a/docs/api/social/classes/_google_provider_service_.googleprovider.md +++ b/docs/api/social/classes/_google_provider_service_.googleprovider.md @@ -49,7 +49,7 @@ Google social provider. *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[authEndpoint](_abstract_provider_service_.abstractprovider.md#authendpoint)* -*Defined in [google-provider.service.ts:30](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L30)* +*Defined in [google-provider.service.ts:32](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L32)* ___ @@ -60,7 +60,7 @@ ___ *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[configInstance](_abstract_provider_service_.abstractprovider.md#configinstance)* -*Defined in [abstract-provider.service.ts:90](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L90)* +*Defined in [abstract-provider.service.ts:106](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L106)* ___ @@ -71,7 +71,7 @@ ___ *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[defaultScopes](_abstract_provider_service_.abstractprovider.md#defaultscopes)* -*Defined in [google-provider.service.ts:33](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L33)* +*Defined in [google-provider.service.ts:35](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L35)* ___ @@ -82,7 +82,7 @@ ___ *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[scopeSeparator](_abstract_provider_service_.abstractprovider.md#scopeseparator)* -*Defined in [abstract-provider.service.ts:144](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L144)* +*Defined in [abstract-provider.service.ts:160](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L160)* Character used to separate the scopes in the URL. @@ -99,7 +99,7 @@ ___ *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[tokenEndpoint](_abstract_provider_service_.abstractprovider.md#tokenendpoint)* -*Defined in [google-provider.service.ts:31](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L31)* +*Defined in [google-provider.service.ts:33](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L33)* ___ @@ -113,7 +113,7 @@ ___ *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[getTokens](_abstract_provider_service_.abstractprovider.md#gettokens)* -*Defined in [abstract-provider.service.ts:219](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L219)* +*Defined in [abstract-provider.service.ts:235](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L235)* Function to use in the controller method that handles the provider redirection. @@ -139,7 +139,7 @@ ___ *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[getUserInfo](_abstract_provider_service_.abstractprovider.md#getuserinfo)* -*Defined in [abstract-provider.service.ts:262](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L262)* +*Defined in [abstract-provider.service.ts:278](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L278)* Function to use in the controller method that handles the provider redirection. @@ -171,7 +171,7 @@ ___ *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[getUserInfoFromTokens](_abstract_provider_service_.abstractprovider.md#getuserinfofromtokens)* -*Defined in [google-provider.service.ts:35](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L35)* +*Defined in [google-provider.service.ts:37](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L37)* **Parameters:** @@ -190,7 +190,7 @@ ___ *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[redirect](_abstract_provider_service_.abstractprovider.md#redirect)* -*Defined in [abstract-provider.service.ts:175](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L175)* +*Defined in [abstract-provider.service.ts:191](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L191)* Returns an HttpResponseRedirect object to use to redirect the user to the social provider's authorization page. @@ -221,7 +221,7 @@ ___ *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[configPaths](_abstract_provider_service_.abstractprovider.md#configpaths)* -*Defined in [google-provider.service.ts:25](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L25)* +*Defined in [google-provider.service.ts:27](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L27)* @@ -229,7 +229,7 @@ ___ **● clientId**: *`string`* = "settings.social.google.clientId" -*Defined in [google-provider.service.ts:26](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L26)* +*Defined in [google-provider.service.ts:28](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L28)* ___ @@ -238,7 +238,7 @@ ___ **● clientSecret**: *`string`* = "settings.social.google.clientSecret" -*Defined in [google-provider.service.ts:27](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L27)* +*Defined in [google-provider.service.ts:29](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L29)* ___ @@ -247,7 +247,7 @@ ___ **● redirectUri**: *`string`* = "settings.social.google.redirectUri" -*Defined in [google-provider.service.ts:28](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L28)* +*Defined in [google-provider.service.ts:30](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L30)* ___ diff --git a/docs/api/social/classes/_google_provider_service_.invalidjwterror.md b/docs/api/social/classes/_google_provider_service_.invalidjwterror.md index 7a3db6f981..4d99104d1a 100644 --- a/docs/api/social/classes/_google_provider_service_.invalidjwterror.md +++ b/docs/api/social/classes/_google_provider_service_.invalidjwterror.md @@ -36,11 +36,11 @@ ___ ### name -**● name**: *`string`* +**● name**: *"InvalidJWTError"* = "InvalidJWTError" -*Inherited from Error.name* +*Overrides Error.name* -*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/social/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:963* +*Defined in [google-provider.service.ts:16](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L16)* ___ diff --git a/docs/api/social/interfaces/_abstract_provider_service_.socialtokens.md b/docs/api/social/interfaces/_abstract_provider_service_.socialtokens.md index b26468334b..bc2558cd00 100644 --- a/docs/api/social/interfaces/_abstract_provider_service_.socialtokens.md +++ b/docs/api/social/interfaces/_abstract_provider_service_.socialtokens.md @@ -34,7 +34,7 @@ Tokens returned by an OAuth2 authorization server. **● access_token**: *`string`* -*Defined in [abstract-provider.service.ts:17](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L17)* +*Defined in [abstract-provider.service.ts:17](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L17)* ___ @@ -43,7 +43,7 @@ ___ **● token_type**: *`string`* -*Defined in [abstract-provider.service.ts:18](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L18)* +*Defined in [abstract-provider.service.ts:18](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L18)* ___ diff --git a/docs/api/social/interfaces/_abstract_provider_service_.userinfoandtokens.md b/docs/api/social/interfaces/_abstract_provider_service_.userinfoandtokens.md index 7349a067b2..a9794ed04a 100644 --- a/docs/api/social/interfaces/_abstract_provider_service_.userinfoandtokens.md +++ b/docs/api/social/interfaces/_abstract_provider_service_.userinfoandtokens.md @@ -33,7 +33,7 @@ Objects returned by the method AbstractProvider.getUserInfo. **● tokens**: *[SocialTokens](_abstract_provider_service_.socialtokens.md)* -*Defined in [abstract-provider.service.ts:31](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L31)* +*Defined in [abstract-provider.service.ts:31](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L31)* ___ @@ -42,7 +42,7 @@ ___ **● userInfo**: *`UserInfo`* -*Defined in [abstract-provider.service.ts:30](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L30)* +*Defined in [abstract-provider.service.ts:30](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L30)* ___ diff --git a/docs/api/social/interfaces/_facebook_provider_service_.facebookauthparams.md b/docs/api/social/interfaces/_facebook_provider_service_.facebookauthparams.md index 3def7549b2..e799adb74b 100644 --- a/docs/api/social/interfaces/_facebook_provider_service_.facebookauthparams.md +++ b/docs/api/social/interfaces/_facebook_provider_service_.facebookauthparams.md @@ -22,7 +22,7 @@ **● auth_type**: *`undefined` \| "rerequest"* -*Defined in [facebook-provider.service.ts:11](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L11)* +*Defined in [facebook-provider.service.ts:11](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L11)* ___ diff --git a/docs/api/social/interfaces/_facebook_provider_service_.facebookuserinfoparams.md b/docs/api/social/interfaces/_facebook_provider_service_.facebookuserinfoparams.md index 4e7d60986e..7fcf5e0c53 100644 --- a/docs/api/social/interfaces/_facebook_provider_service_.facebookuserinfoparams.md +++ b/docs/api/social/interfaces/_facebook_provider_service_.facebookuserinfoparams.md @@ -22,7 +22,7 @@ **● fields**: *`string`[]* -*Defined in [facebook-provider.service.ts:15](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L15)* +*Defined in [facebook-provider.service.ts:15](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L15)* ___ diff --git a/docs/api/social/interfaces/_google_provider_service_.googleauthparams.md b/docs/api/social/interfaces/_google_provider_service_.googleauthparams.md index 10a4cf040b..0a15791149 100644 --- a/docs/api/social/interfaces/_google_provider_service_.googleauthparams.md +++ b/docs/api/social/interfaces/_google_provider_service_.googleauthparams.md @@ -29,7 +29,7 @@ **● access_type**: *"offline" \| "online"* -*Defined in [google-provider.service.ts:9](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L9)* +*Defined in [google-provider.service.ts:9](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L9)* ___ @@ -38,7 +38,7 @@ ___ **● display**: *`undefined` \| `string`* -*Defined in [google-provider.service.ts:7](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L7)* +*Defined in [google-provider.service.ts:7](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L7)* ___ @@ -47,7 +47,7 @@ ___ **● hd**: *`undefined` \| `string`* -*Defined in [google-provider.service.ts:12](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L12)* +*Defined in [google-provider.service.ts:12](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L12)* ___ @@ -56,7 +56,7 @@ ___ **● include_granted_scopes**: *`true` \| `false`* -*Defined in [google-provider.service.ts:10](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L10)* +*Defined in [google-provider.service.ts:10](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L10)* ___ @@ -65,7 +65,7 @@ ___ **● login_hint**: *`undefined` \| `string`* -*Defined in [google-provider.service.ts:8](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L8)* +*Defined in [google-provider.service.ts:8](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L8)* ___ @@ -74,7 +74,7 @@ ___ **● nonce**: *`undefined` \| `string`* -*Defined in [google-provider.service.ts:5](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L5)* +*Defined in [google-provider.service.ts:5](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L5)* ___ @@ -83,7 +83,7 @@ ___ **● openid.realm**: *`undefined` \| `string`* -*Defined in [google-provider.service.ts:11](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L11)* +*Defined in [google-provider.service.ts:11](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L11)* ___ @@ -92,7 +92,7 @@ ___ **● prompt**: *"none" \| "consent" \| "select_account"* -*Defined in [google-provider.service.ts:6](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/google-provider.service.ts#L6)* +*Defined in [google-provider.service.ts:6](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/google-provider.service.ts#L6)* ___ diff --git a/docs/api/social/modules/_abstract_provider_service_.md b/docs/api/social/modules/_abstract_provider_service_.md index 77ab590f7b..475485b286 100644 --- a/docs/api/social/modules/_abstract_provider_service_.md +++ b/docs/api/social/modules/_abstract_provider_service_.md @@ -31,7 +31,7 @@ **● STATE_COOKIE_NAME**: *"oauth2-state"* = "oauth2-state" -*Defined in [abstract-provider.service.ts:73](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L73)* +*Defined in [abstract-provider.service.ts:89](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L89)* ___