Skip to content

Commit 7f316f8

Browse files
sidolovsidolov
authored
ENGCOM-9253: [ReadMe] updated readMe file for LoginAsCustomer-Marketplace modules #31877 
2 parents 80a4f26 + 965370e commit 7f316f8

File tree

11 files changed

+207
-15
lines changed

11 files changed

+207
-15
lines changed

‎app/code/Magento/LoginAsCustomer/README.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
11
# Magento_LoginAsCustomer module
22

3-
The Magento_LoginAsCustomer module is responsible for ability to login into customer account using the admin panel.
3+
This module is responsible for ability to login into customer account using the admin panel.
4+
5+
## Installation
6+
7+
The Magento_LoginAsCustomer module creates the `login_as_customer` table in the database.
8+
9+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
10+
11+
## Additional information
12+
13+
This module is a part of Login As Customer feature.
14+
15+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html)

‎app/code/Magento/LoginAsCustomerAdminUi/README.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1-
# Magento_LoginAsCustomerSales module
1+
# Magento_LoginAsCustomerAdminUi module
22

3-
The Magento_LoginAsCustomerAdminUi module provides UI for Admin Panel
3+
This module provides UI for Admin Panel for Login As Customer functionality.
4+
5+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_LoginAsCustomerAdminUi module.
6+
7+
## Additional information
8+
9+
This module is a part of Login As Customer feature.
10+
11+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

‎app/code/Magento/LoginAsCustomerApi/README.md‎

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,57 @@
1-
# Magento_LoginAsCustomer module
1+
# Magento_LoginAsCustomerApi module
22

3-
The Magento_LoginAsCustomerApi module provides API for ability to login into customer account for an admin user.
3+
This module provides API for ability to login into customer account for an admin user.
4+
5+
### Public APIs
6+
7+
- `\Magento\LoginAsCustomerApi\Api\Data\AuthenticationDataInterface`:
8+
- contains authentication data
9+
10+
-`\Magento\LoginAsCustomerApi\Api\Data\IsLoginAsCustomerEnabledForCustomerResultInterface`:
11+
- contains the result of the check whether the login as customer is enabled
12+
13+
- `\Magento\LoginAsCustomerApi\Api\AuthenticateCustomerBySecretInterface`:
14+
- authenticate a customer by secret
15+
16+
- `\Magento\LoginAsCustomerApi\Api\ConfigInterface`:
17+
- check if Login as Customer extension is enabled
18+
- check if store view manual choice is enabled
19+
- get authentication data expiration time (in seconds)
20+
21+
- `\Magento\LoginAsCustomerApi\Api\DeleteAuthenticationDataForUserInterface`:
22+
- delete authentication data by user id
23+
24+
- `\Magento\LoginAsCustomerApi\Api\GenerateAuthenticationSecretInterface`:
25+
- generate authentication secret
26+
27+
- `\Magento\LoginAsCustomerApi\Api\GetAuthenticationDataBySecretInterface`:
28+
- get authentication data by secret
29+
30+
- `\Magento\LoginAsCustomerApi\Api\GetLoggedAsCustomerAdminIdInterface`:
31+
- get id of admin logged as customer
32+
33+
- `\Magento\LoginAsCustomerApi\Api\GetLoggedAsCustomerCustomerIdInterface`:
34+
- get id of customer admin is logged as
35+
36+
- `\Magento\LoginAsCustomerApi\Api\IsLoginAsCustomerEnabledForCustomerInterface`:
37+
- check if login as customer functionality is enabled for customer
38+
39+
- `\Magento\LoginAsCustomerApi\Api\IsLoginAsCustomerSessionActiveInterface`:
40+
- check if Login as Customer session is still active
41+
42+
- `\Magento\LoginAsCustomerApi\Api\SaveAuthenticationDataInterface`:
43+
- save authentication data. Return secret key
44+
45+
- `\Magento\LoginAsCustomerApi\Api\SetLoggedAsCustomerAdminIdInterface`:
46+
- set id of admin logged as customer
47+
48+
- `\Magento\LoginAsCustomerApi\Api\SetLoggedAsCustomerCustomerIdInterface`:
49+
- set id of customer admin is logged as
50+
51+
For information about a public API in Magento 2, see [Public interfaces & APIs](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html).
52+
53+
## Additional information
54+
55+
This module is a part of Login As Customer feature.
56+
57+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

‎app/code/Magento/LoginAsCustomerAssistance/README.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
11
# Magento_LoginAsCustomerAssistance module
22

3-
The Magento_LoginAsCustomerAssistance module provides possibility to enable/disable LoginAsCustomer functionality per Customer.
3+
This module provides possibility to enable/disable LoginAsCustomer functionality per Customer.
4+
5+
## Installation
6+
7+
The Magento_LoginAsCustomerAssistance module creates the `login_as_customer_assistance_allowed` table in the database.
8+
9+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
10+
11+
## Additional information
12+
13+
This module is a part of Login As Customer feature.
14+
15+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

‎app/code/Magento/LoginAsCustomerFrontendUi/README.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1-
# Magento_LoginAsCustomerSales module
1+
# Magento_LoginAsCustomerFrontendUi module
22

3-
The Magento_LoginAsCustomerFrontendUi module provides UI for Storefront
3+
This module provides UI for Storefront for Login As Customer functionality.
4+
5+
## Additional information
6+
7+
This module is a part of Login As Customer feature.
8+
9+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

‎app/code/Magento/LoginAsCustomerGraphQl/README.md‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1-
# LoginAsCustomerGraphQl
1+
# Magento_LoginAsCustomerGraphQl module
22

3-
**LoginAsCustomerGraphQl** provides flexible login as a customer so a merchant or merchant admin can log into an end customer's account to assist them with their account.
3+
This module provides flexible login as a customer using GraphQl so a merchant or merchant admin can log into an end customer's account to assist them with their account.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_GroupedProductGraphQl is dependent on the following modules:
8+
9+
- Magento_LoginAsCustomerApi
10+
- Magento_Customer
11+
- Magento_Store
12+
- Magento_CatalogGraphQlr
13+
14+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
15+
16+
## Additional information
17+
18+
This module is a part of Login As Customer feature.
19+
20+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).
21+
22+
You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql).

‎app/code/Magento/LoginAsCustomerLog/README.md‎

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
11
# Magento_LoginAsCustomerLog module
22

3-
The Magento_LoginAsCustomerLog module provides log for Login as Customer functionality
3+
This module provides log for Login as Customer functionality
4+
5+
## Installation
6+
7+
The Magento_LoginAsCustomerLog module creates the `magento_login_as_customer_log` table in the database.
8+
9+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
10+
11+
### Layouts
12+
13+
This module introduces the following layouts in the `view/adminhtml/layout` directory:
14+
- `loginascustomer_log_log_index`
15+
16+
For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).
17+
18+
### UI components
19+
20+
You can extend log listing updates using the configuration files located in the directories
21+
- `view/adminhtml/ui_component`:
22+
- `login_as_customer_log_listing`
23+
24+
For information about a UI component in Magento 2, see [Overview of UI components](http://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html).
25+
26+
### Public APIs
27+
28+
- `\Magento\LoginAsCustomerLog\Api\Data\LogInterface`
29+
- login as customer log data
30+
31+
- `\Magento\LoginAsCustomerLog\Api\Data\LogSearchResultsInterface`
32+
- login as customer log entity search results data
33+
34+
- `\Magento\LoginAsCustomerLog\Api\GetLogsListInterface`:
35+
- get login as customer log list considering search criteria
36+
37+
- `\Magento\LoginAsCustomerLog\Api\SaveLogsInterface`:
38+
- save login as custom logs entities
39+
40+
For information about a public API in Magento 2, see [Public interfaces & APIs](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html).
41+
42+
## Additional information
43+
44+
This module is a part of Login As Customer feature.
45+
46+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

‎app/code/Magento/LoginAsCustomerPageCache/README.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1-
# LoginAsCustomerPageCache module
1+
# Magento_LoginAsCustomerPageCache module
22

3-
The Magento_LoginAsCustomerPageCache module provides adaptation to PageCache functionality
3+
This module provides adaptation to PageCache functionality for Login as Customer functionality.
4+
5+
## Additional information
6+
7+
This module is a part of Login As Customer feature.
8+
9+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

‎app/code/Magento/LoginAsCustomerQuote/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# Magento_LoginAsCustomerQuote module
22

33
The Magento_LoginAsCustomerQuote module is responsible for communication between Magento_LoginAsCustomer and shopping cart state.
4+
5+
## Additional information
6+
7+
This module is a part of Login As Customer feature.
8+
9+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

‎app/code/Magento/LoginAsCustomerSales/README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# Magento_LoginAsCustomerSales module
22

3-
The Magento_LoginAsCustomerSales module is responsible for communication between Magento_LoginAsCustomer and order placement.
3+
This module is responsible for communication between Magento_LoginAsCustomer and order placement.
4+
5+
## Additional information
6+
7+
This module is a part of Login As Customer feature.
8+
9+
[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html).

0 commit comments

Comments
 (0)