inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation build (#6762)

Browse Source 
* move doc dependency in doctools

* add ignore link

* rebuild doc

* version index

* put it back some deps
This commit is contained in:
Eugenio Romano
2021-03-03 14:08:15 +00:00
committed by GitHub
parent e05c80f04f
commit c3452a4f62
227 changed files with 6994 additions and 4146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

114
docs/core/services/authentication.service.md
View File

@@ -13,85 +13,87 @@ Provides authentication to ACS and APS.
### Methods
* **addTokenToHeader**(headersArg?: `HttpHeaders`): [`Observable`](http://reactivex.io/documentation/observable.html)`<HttpHeaders>`<br/>
- **addTokenToHeader**(headersArg?: `HttpHeaders`): [`Observable`](http://reactivex.io/documentation/observable.html)`<HttpHeaders>`<br/>
Adds the auth token to an HTTP header using the 'bearer' scheme.
* *headersArg:* `HttpHeaders` - (Optional) Header that will receive the token
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<HttpHeaders>` - The new header with the token added
* **getBearerExcludedUrls**(): `string[]`<br/>
- _headersArg:_ `HttpHeaders` - (Optional) Header that will receive the token
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<HttpHeaders>` - The new header with the token added
- **getBearerExcludedUrls**(): `string[]`<br/>
Gets the set of URLs that the token bearer is excluded from.
* **Returns** `string[]` - Array of URL strings
* **getBpmLoggedUser**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>`<br/>
- **Returns** `string[]` - Array of URL strings
- **getBpmLoggedUser**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>`<br/>
Gets information about the user currently logged into APS.
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>` - User information
* **getBpmUsername**(): `string`<br/>
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>` - User information
- **getBpmUsername**(): `string`<br/>
Gets the BPM username
* **Returns** `string` - The BPM username
* **getEcmUsername**(): `string`<br/>
- **Returns** `string` - The BPM username
- **getEcmUsername**(): `string`<br/>
Gets the ECM username.
* **Returns** `string` - The ECM username
* **getRedirect**(): `string`<br/>
- **Returns** `string` - The ECM username
- **getRedirect**(): `string`<br/>
Gets the URL to redirect to after login.
* **Returns** `string` - The redirect URL
* **getTicketBpm**(): `string|null`<br/>
- **Returns** `string` - The redirect URL
- **getTicketBpm**(): `string|null`<br/>
Gets the BPM ticket stored in the Storage.
* **Returns** `string|null` - The ticket or `null` if none was found
* **getTicketEcm**(): `string|null`<br/>
- **Returns** `string|null` - The ticket or `null` if none was found
- **getTicketEcm**(): `string|null`<br/>
Gets the ECM ticket stored in the Storage.
* **Returns** `string|null` - The ticket or `null` if none was found
* **getTicketEcmBase64**(): `string|null`<br/>
- **Returns** `string|null` - The ticket or `null` if none was found
- **getTicketEcmBase64**(): `string|null`<br/>
Gets the BPM ticket from the Storage in Base 64 format.
* **Returns** `string|null` - The ticket or `null` if none was found
* **getToken**(): `string`<br/>
- **Returns** `string|null` - The ticket or `null` if none was found
- **getToken**(): `string`<br/>
Gets the auth token.
* **Returns** `string` - Auth token string
* **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- **Returns** `string` - Auth token string
- **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Prints an error message in the console browser
* *error:* `any` - Error message
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Object representing the error message
* **isALLProvider**(): `boolean`<br/>
- _error:_ `any` - Error message
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Object representing the error message
- **isALLProvider**(): `boolean`<br/>
Does the provider support both ECM and BPM?
* **Returns** `boolean` - True if both are supported, false otherwise
* **isBPMProvider**(): `boolean`<br/>
- **Returns** `boolean` - True if both are supported, false otherwise
- **isBPMProvider**(): `boolean`<br/>
Does the provider support BPM?
* **Returns** `boolean` - True if supported, false otherwise
* **isBpmLoggedIn**(): `boolean`<br/>
- **Returns** `boolean` - True if supported, false otherwise
- **isBpmLoggedIn**(): `boolean`<br/>
Checks if the user is logged in on a BPM provider.
* **Returns** `boolean` - True if logged in, false otherwise
* **isECMProvider**(): `boolean`<br/>
- **Returns** `boolean` - True if logged in, false otherwise
- **isECMProvider**(): `boolean`<br/>
Does the provider support ECM?
* **Returns** `boolean` - True if supported, false otherwise
* **isEcmLoggedIn**(): `boolean`<br/>
- **Returns** `boolean` - True if supported, false otherwise
- **isEcmLoggedIn**(): `boolean`<br/>
Checks if the user is logged in on an ECM provider.
* **Returns** `boolean` - True if logged in, false otherwise
* **isLoggedIn**(): `boolean`<br/>
- **Returns** `boolean` - True if logged in, false otherwise
- **isLoggedIn**(): `boolean`<br/>
Checks if the user logged in.
* **Returns** `boolean` - True if logged in, false otherwise
* **isLoggedInWith**(provider: `string`): `boolean`<br/>
- **Returns** `boolean` - True if logged in, false otherwise
- **isLoggedInWith**(provider: `string`): `boolean`<br/>
* *provider:* `string` -
* **Returns** `boolean` -
* **isOauth**(): `boolean`<br/>
- _provider:_ `string` -
- **Returns** `boolean` -
- **isOauth**(): `boolean`<br/>
Does the provider support OAuth?
* **Returns** `boolean` - True if supported, false otherwise
* **isPublicUrl**(): `boolean`<br/>
- **Returns** `boolean` - True if supported, false otherwise
- **isPublicUrl**(): `boolean`<br/>
* **Returns** `boolean` -
* **isRememberMeSet**(): `boolean`<br/>
- **Returns** `boolean` -
- **isRememberMeSet**(): `boolean`<br/>
Checks whether the "remember me" cookie was set or not.
* **Returns** `boolean` - True if set, false otherwise
* **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>`<br/>
- **Returns** `boolean` - True if set, false otherwise
- **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>`<br/>
Logs the user in.
* *username:* `string` - Username for the login
* *password:* `string` - Password for the login
* *rememberMe:* `boolean` - Stores the user's login details if true
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket
* **logout**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- _username:_ `string` - Username for the login
- _password:_ `string` - Password for the login
- _rememberMe:_ `boolean` - Stores the user's login details if true
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket
- **logout**(): `any`<br/>
Logs the user out.
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Response event called when logout is complete
* **setRedirect**(url: [`RedirectionModel`](../../../lib/core/models/redirection.model.ts))<br/>
- **Returns** `any` - Response event called when logout is complete
- **setRedirect**(url: [`RedirectionModel`](../../../lib/core/models/redirection.model.ts))<br/>
Sets the URL to redirect to after login.
* *url:* [`RedirectionModel`](../../../lib/core/models/redirection.model.ts) - URL to redirect to
* **ssoImplicitLogin**()<br/>
- _url:_ [`RedirectionModel`](../../../lib/core/models/redirection.model.ts) - URL to redirect to
- **ssoImplicitLogin**()<br/>
Logs the user in with SSO
## Details
@@ -118,4 +120,4 @@ export class AppComponent {
## See also
* [Login component](../components/login.component.md)
- [Login component](../components/login.component.md)