-
Notifications
You must be signed in to change notification settings - Fork 9.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ENGCOM-9253: [ReadMe] updated readMe file for LoginAsCustomer-Marketp…
…lace modules #31877 - Merge Pull Request #31877 from vlmed/magento2:update_readme_login-as-customer-marketplace - Merged commits: 1. 0ba4767 2. 4372776 3. bf63f1a
- Loading branch information
Showing
11 changed files
with
207 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,15 @@ | ||
| # Magento_LoginAsCustomer module | ||
|
|
||
| The Magento_LoginAsCustomer module is responsible for ability to login into customer account using the admin panel. | ||
| This module is responsible for ability to login into customer account using the admin panel. | ||
|
|
||
| ## Installation | ||
|
|
||
| The Magento_LoginAsCustomer module creates the `login_as_customer` table in the database. | ||
|
|
||
| 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). | ||
|
|
||
| ## Additional information | ||
|
|
||
| This module is a part of Login As Customer feature. | ||
|
|
||
| [Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,11 @@ | ||
| # Magento_LoginAsCustomerSales module | ||
| # Magento_LoginAsCustomerAdminUi module | ||
|
|
||
| The Magento_LoginAsCustomerAdminUi module provides UI for Admin Panel | ||
| This module provides UI for Admin Panel for Login As Customer functionality. | ||
|
|
||
| [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. | ||
|
|
||
| ## Additional information | ||
|
|
||
| This module is a part of Login As Customer feature. | ||
|
|
||
| [Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,57 @@ | ||
| # Magento_LoginAsCustomer module | ||
| # Magento_LoginAsCustomerApi module | ||
|
|
||
| The Magento_LoginAsCustomerApi module provides API for ability to login into customer account for an admin user. | ||
| This module provides API for ability to login into customer account for an admin user. | ||
|
|
||
| ### Public APIs | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\Data\AuthenticationDataInterface`: | ||
| - contains authentication data | ||
|
|
||
| -`\Magento\LoginAsCustomerApi\Api\Data\IsLoginAsCustomerEnabledForCustomerResultInterface`: | ||
| - contains the result of the check whether the login as customer is enabled | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\AuthenticateCustomerBySecretInterface`: | ||
| - authenticate a customer by secret | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\ConfigInterface`: | ||
| - check if Login as Customer extension is enabled | ||
| - check if store view manual choice is enabled | ||
| - get authentication data expiration time (in seconds) | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\DeleteAuthenticationDataForUserInterface`: | ||
| - delete authentication data by user id | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\GenerateAuthenticationSecretInterface`: | ||
| - generate authentication secret | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\GetAuthenticationDataBySecretInterface`: | ||
| - get authentication data by secret | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\GetLoggedAsCustomerAdminIdInterface`: | ||
| - get id of admin logged as customer | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\GetLoggedAsCustomerCustomerIdInterface`: | ||
| - get id of customer admin is logged as | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\IsLoginAsCustomerEnabledForCustomerInterface`: | ||
| - check if login as customer functionality is enabled for customer | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\IsLoginAsCustomerSessionActiveInterface`: | ||
| - check if Login as Customer session is still active | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\SaveAuthenticationDataInterface`: | ||
| - save authentication data. Return secret key | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\SetLoggedAsCustomerAdminIdInterface`: | ||
| - set id of admin logged as customer | ||
|
|
||
| - `\Magento\LoginAsCustomerApi\Api\SetLoggedAsCustomerCustomerIdInterface`: | ||
| - set id of customer admin is logged as | ||
|
|
||
| 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). | ||
|
|
||
| ## Additional information | ||
|
|
||
| This module is a part of Login As Customer feature. | ||
|
|
||
| [Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,15 @@ | ||
| # Magento_LoginAsCustomerAssistance module | ||
|
|
||
| The Magento_LoginAsCustomerAssistance module provides possibility to enable/disable LoginAsCustomer functionality per Customer. | ||
| This module provides possibility to enable/disable LoginAsCustomer functionality per Customer. | ||
|
|
||
| ## Installation | ||
|
|
||
| The Magento_LoginAsCustomerAssistance module creates the `login_as_customer_assistance_allowed` table in the database. | ||
|
|
||
| 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). | ||
|
|
||
| ## Additional information | ||
|
|
||
| This module is a part of Login As Customer feature. | ||
|
|
||
| [Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,9 @@ | ||
| # Magento_LoginAsCustomerSales module | ||
| # Magento_LoginAsCustomerFrontendUi module | ||
|
|
||
| The Magento_LoginAsCustomerFrontendUi module provides UI for Storefront | ||
| This module provides UI for Storefront for Login As Customer functionality. | ||
|
|
||
| ## Additional information | ||
|
|
||
| This module is a part of Login As Customer feature. | ||
|
|
||
| [Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,22 @@ | ||
| # LoginAsCustomerGraphQl | ||
| # Magento_LoginAsCustomerGraphQl module | ||
|
|
||
| **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. | ||
| 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. | ||
|
|
||
| ## Installation | ||
|
|
||
| Before installing this module, note that the Magento_GroupedProductGraphQl is dependent on the following modules: | ||
|
|
||
| - Magento_LoginAsCustomerApi | ||
| - Magento_Customer | ||
| - Magento_Store | ||
| - Magento_CatalogGraphQlr | ||
|
|
||
| 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). | ||
|
|
||
| ## Additional information | ||
|
|
||
| This module is a part of Login As Customer feature. | ||
|
|
||
| [Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). | ||
|
|
||
| You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,46 @@ | ||
| # Magento_LoginAsCustomerLog module | ||
|
|
||
| The Magento_LoginAsCustomerLog module provides log for Login as Customer functionality | ||
| This module provides log for Login as Customer functionality | ||
|
|
||
| ## Installation | ||
|
|
||
| The Magento_LoginAsCustomerLog module creates the `magento_login_as_customer_log` table in the database. | ||
|
|
||
| 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). | ||
|
|
||
| ### Layouts | ||
|
|
||
| This module introduces the following layouts in the `view/adminhtml/layout` directory: | ||
| - `loginascustomer_log_log_index` | ||
|
|
||
| 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). | ||
|
|
||
| ### UI components | ||
|
|
||
| You can extend log listing updates using the configuration files located in the directories | ||
| - `view/adminhtml/ui_component`: | ||
| - `login_as_customer_log_listing` | ||
|
|
||
| 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). | ||
|
|
||
| ### Public APIs | ||
|
|
||
| - `\Magento\LoginAsCustomerLog\Api\Data\LogInterface` | ||
| - login as customer log data | ||
|
|
||
| - `\Magento\LoginAsCustomerLog\Api\Data\LogSearchResultsInterface` | ||
| - login as customer log entity search results data | ||
|
|
||
| - `\Magento\LoginAsCustomerLog\Api\GetLogsListInterface`: | ||
| - get login as customer log list considering search criteria | ||
|
|
||
| - `\Magento\LoginAsCustomerLog\Api\SaveLogsInterface`: | ||
| - save login as custom logs entities | ||
|
|
||
| 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). | ||
|
|
||
| ## Additional information | ||
|
|
||
| This module is a part of Login As Customer feature. | ||
|
|
||
| [Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,9 @@ | ||
| # LoginAsCustomerPageCache module | ||
| # Magento_LoginAsCustomerPageCache module | ||
|
|
||
| The Magento_LoginAsCustomerPageCache module provides adaptation to PageCache functionality | ||
| This module provides adaptation to PageCache functionality for Login as Customer functionality. | ||
|
|
||
| ## Additional information | ||
|
|
||
| This module is a part of Login As Customer feature. | ||
|
|
||
| [Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,9 @@ | ||
| # Magento_LoginAsCustomerQuote module | ||
|
|
||
| The Magento_LoginAsCustomerQuote module is responsible for communication between Magento_LoginAsCustomer and shopping cart state. | ||
|
|
||
| ## Additional information | ||
|
|
||
| This module is a part of Login As Customer feature. | ||
|
|
||
| [Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,9 @@ | ||
| # Magento_LoginAsCustomerSales module | ||
|
|
||
| The Magento_LoginAsCustomerSales module is responsible for communication between Magento_LoginAsCustomer and order placement. | ||
| This module is responsible for communication between Magento_LoginAsCustomer and order placement. | ||
|
|
||
| ## Additional information | ||
|
|
||
| This module is a part of Login As Customer feature. | ||
|
|
||
| [Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,21 @@ | ||
| The Magento_Marketplace module allows to display partners of Magento in the backend. | ||
| # Magento_Marketplace module | ||
|
|
||
| This module allows to display partners of Magento in the backend. | ||
|
|
||
| ## Installation | ||
|
|
||
| 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). | ||
|
|
||
| ## Extensibility | ||
|
|
||
| Extension developers can interact with the Magento_Marketplace module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html). | ||
|
|
||
| [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_Marketplace module. | ||
|
|
||
| ### Layouts | ||
|
|
||
| This module introduces the following layouts in the `view/adminhtml/layout` directory: | ||
| - `marketplace_index_index` | ||
| - `marketplace_partners_index` | ||
|
|
||
| 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). |