Browse Source

Quick fix for the OAuth-Module doc

pull/15261/head
Hamza Albreem 3 years ago
committed by GitHub
parent
commit
e5c414f87c
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 12
      docs/en/UI/Angular/OAuth-Module.md

12
docs/en/UI/Angular/OAuth-Module.md

@ -9,13 +9,13 @@ Those abstractions can be found in the @abp/ng-core packages.
- `AuthGuard` (the class that implements the IAuthGuard interface).
- `ApiInterceptor` (the class that implements the IApiInterceptor interface).
Those base classes are overridden by the "AbpOAuthModule" for oAuth. Also there are three function that provided with AbpOAuthModule.
Those base classes are overridden by the "AbpOAuthModule" for oAuth. There are also three functions provided with AbpOAuthModule.
- `PIPE_TO_LOGIN_FN_KEY` that provide to a function that will be called when the user is not authenticated. the function should be PipeToLoginFn type.
- `SET_TOKEN_RESPONSE_TO_STORAGE_FN_KEY` that provide to a function that will be called when the user is authenticated. the function should be SetTokenResponseToStorageFn type.
- `CHECK_AUTHENTICATION_STATE_FN_KEY` that provide to a function that will be called when the user is authenticated and store auth state. the function should be CheckAuthenticationStateFn type.
the tokens and interfaces in the `@abp/ng.core` package but the implementation of these interfaces is in the `@abp/ng.oauth` package.
- `PIPE_TO_LOGIN_FN_KEY` a provide that calls a function when the user is not authenticated. The function should be PipeToLoginFn type.
- `SET_TOKEN_RESPONSE_TO_STORAGE_FN_KEY` a provide that calls a function when the user is authenticated. The function should be SetTokenResponseToStorageFn type.
- `CHECK_AUTHENTICATION_STATE_FN_KEY` a provide that calls a function when the user is authenticated and stores the auth state. The function should be CheckAuthenticationStateFn type.
The tokens and interfaces are in the `@abp/ng.core` package but the implementation of these interfaces is in the `@abp/ng.oauth` package.
If you want to make your own authentication system, you must also change these 'abstract' classes.
ApiInterceptor is provided by `@abp/ng.core` but overrided with `@abp/ng.oauth`. The ApiInterceptor adds the token, accepted-language, and tenant id to the header of the HTTP request. Also it call http-wait service.
ApiInterceptor is provided by `@abp/ng.core` but overridden with `@abp/ng.oauth`. The ApiInterceptor adds the token, accepted-language, and tenant id to the header of the HTTP request. It also calls the http-wait service.

Loading…
Cancel
Save