summary

CRM.Visitors/Managers/VisitorManager.Async.cs

@@ -13,6 +13,15 @@ namespace Bizgaze.CRM.Visitors.Managers
 {
     internal partial class VisitorManager : BaseManager, IVisitorManager
     {
+        /// <summary>
+        /// This method that retrieves pre-visitor information based on the provided code.
+        /// </summary>
+        /// <param name="srequest">The srequest parameter is used to filter the query</param>
+        /// <param name="code"> represents the code associated with the pre-visitor for which information is being retrieved</param>
+        /// <returns>This method returns a response containing pre-visitor information
+        /// If the pre-visitor is found and its RefStatusId is not equal to 2, indicating that the pre-visitor is not checked out, it returns the pre-visitor information.
+        /// If the pre-visitor is not found, it returns an error response with status code "404" and the message "Please Enter A Valid Uniqueid!".
+        /// If the pre-visitor is found but its RefStatusId is equal to 2, indicating that the pre-visitor is already checked out, it returns an error response with status code "404" and the message "you have been already checked out".</returns>
         [SelectMethod(ApiName = "Get  pre visitors", AppName = "crm", Description = "Get pre visitors", UniqueName = "bizgaze_transact_visitors_Getprevisitors", MethodName = "Getprevisitors", ModuleName = "visitors", PackageName = "bizgaze", ParamName1 = "code")]
         public async Task<SelectResponse<Bizgaze.CRM.Visitors.Infos.Visitor>> GetpreVisitorsAsync(SelectRequest srequest, string code)
         {
@@ -39,6 +48,16 @@ namespace Bizgaze.CRM.Visitors.Managers
 
         }
 
+        /// <summary>
+        /// This method that retrieves visitor information based on the provided code.It queries the CRM system to find visitor data associated with the specified code.
+        /// </summary>
+        /// <param name="srequest">The srequest parameter is used to filter the query</param>
+        /// <param name="code">represents the code associated with the pre-visitor for which information is being retrieved</param>
+        /// <returns>This method returns a response containing visitor information in JSON format.
+        /// If the visitor's RefStatusId is equal to 2, indicating that the visitor is already checked out, it returns an error response with status code "417" and the message "you have been already checked out".
+        /// If the visitor's RefStatusId is equal to 3, indicating that the visitor needs to check-in first, it returns an error response with status code "417" and the message "please Check-In First".
+        /// If the visitor's RefStatusId does not indicate any issues, it retrieves additional visitor information from the database, serializes it to JSON format, and returns it as part of the response.
+        /// </returns>
         [SelectMethod(ApiName = "Get  pre visitors id", AppName = "crm", Description = "Get pre visitors id", UniqueName = "bizgaze_transact_visitors_Getprevisitorsid", MethodName = "getprevisitorid", ModuleName = "visitors", PackageName = "bizgaze", ParamName1 = "code")]
         public async Task<SelectResponse> GetVisitorsIDAsync(SelectRequest srequest, string code)
         {
@@ -65,6 +84,13 @@ namespace Bizgaze.CRM.Visitors.Managers
             return new SelectResponse() { Result = json };
         }
 
+        /// <summary>
+        /// This method that retrieves visitor information based on the provided VisitorId.
+        /// </summary>
+        /// <param name="request">This parameter of type SelectRequest represents the request object used for querying the database</param>
+        /// <param name="VisitorId">This parameter represents the VisitorId of the visitor for which information is being retrieved.</param>
+        /// <returns>This method returns a response containing visitor information, represented by an object of type Infos.Visitor. The response include a single visitor object matching the provided VisitorId or null if no visitor is found.</returns>
+        
         #region Getting data By VisitorId
         // This method gets a visitor record with the given VisitorId. It takes a SelectRequest as parameter and returns a SelectResponse<Infos.Visitor> object.
         public async Task<SelectResponse<Infos.Visitor>> GetVisitorByIdAsync(SelectRequest request, long VisitorId)
@@ -76,6 +102,15 @@ namespace Bizgaze.CRM.Visitors.Managers
             return data;
         }
         #endregion
+        /// <summary>
+        /// This method that retrieves detailed visitor data based on the provided VisitorId.visitor information associated with the specified ID, including details such as fullname, code, check-in datetime, cityname, contactname, purposeofvisit, and photourl.
+        /// </summary>
+        /// <param name="request">This parameter of type SelectRequest represents the request object used for querying the database</param>
+        /// <param name="VisitorId">represents the VisitorId of the visitor for which detailed information is being retrieved.</param>
+        /// <returns>This method returns a response containing detailed visitor information in JSON format.
+        /// The detailed information includes visitor's fullname, code, check-in datetime, cityname, contactname, purposeofvisit type, and photourl.
+        /// f the visitor is not found based on the provided VisitorId, the method returns an empty response.
+        /// If the visitor is found, the detailed information is serialized to JSON format and returned as part of the response</returns>
         #region Getting data By VisitorId
         public async Task<SelectResponse> GetVisitordataByIdAsync(SelectRequest request, long VisitorId)
         {
@@ -95,7 +130,15 @@ namespace Bizgaze.CRM.Visitors.Managers
             return new SelectResponse() { Result = json };
         }
         #endregion
-
+        /// <summary>
+        /// This method is used to get the html of a visitor. It takes a Visitor ID as an argument, then gets the related templates from Unibase.Platform.Templates.Managers.ITemplateManager, if the templates are found the id is assigned to the variable "templateid" and the information from GetVisitorByIdAsync is used to populate the fields in the template. In the end, the PrintTemplate object is returned with the PrintHTML.
+        /// </summary>
+        /// <param name="srequest">The srequest parameter is used to filter the query</param>
+        /// <param name="VisitorId">This parameter represents the VisitorId of the visitor for which HTML content is being generated</param>
+        /// <returns>This method returns a response containing HTML content for printing visitor information.
+        /// If the visitor data is successfully retrieved and the template is found, the method replaces placeholders in the template with the corresponding visitor information and returns the HTML content as part of the response
+        /// If the visitor data is not found, it returns an error response with status code "1" and the message "visitor Not Found".
+        /// If the template is not found, it returns an error response with status code "1" and the message "Template Not Found".</returns>
         #region Get Visitors html
         //This method is used to get the html of a visitor. It takes a Visitor ID as an argument, then gets the related templates from Unibase.Platform.Templates.Managers.ITemplateManager, if the templates are found the id is assigned to the variable "templateid" and the information from GetVisitorByIdAsync is used to populate the fields in the template. In the end, the PrintTemplate object is returned with the PrintHTML.
         [SelectMethod(ApiName = "Get visitors Html", AppName = "crm", Description = "Get visitors Html", UniqueName = "bizgaze_transact_visitors_GetvisitorsHtml", MethodName = "getvisitorshtml", ModuleName = "visitors", PackageName = "bizgaze", ParamName1 = "visitorid")]
@@ -189,7 +232,12 @@ namespace Bizgaze.CRM.Visitors.Managers
          /***/
 
 
-
+        /// <summary>
+        /// This action method is used to update the agreement status of the visitors in the bizgazecrm_visitors table.
+        /// </summary>
+        /// <param name="arequest">This parameter of type ActionRequest represents the request object used for updating the agreement status</param>
+        /// <param name="VisitorId">The VisitorId of the visitor whose status is to be updated. </param>
+        /// <returns>Returns success or error response based on the success of the query. </returns>
 
         #region Visitor Agreement
         /* 
@@ -222,7 +270,14 @@ namespace Bizgaze.CRM.Visitors.Managers
         #endregion
 
         #region check Mobile Number
-        /** 
+        /// <summary>
+        /// This method is used to check the existing mobile number and email id in the Visitors table and if exists same mobile number or email return an error response.
+        /// </summary>
+        /// <param name="arequest">This parameter of type ActionRequest represents the request object used for checking the mobile number and emailID.</param>
+        /// <param name="mobileNumber">represents the mobile number to be checked</param>
+        /// <param name="emailId"> represents the email ID to be checked</param>
+        /// <returns>This method returns a response indicating the outcome of the mobile number and email ID check.</returns>
+        /* 
         * Api Name: check Mobile Number 
         * App Name: crm 
         * Description: check Mobile Numbert 
@@ -248,9 +303,14 @@ namespace Bizgaze.CRM.Visitors.Managers
         }
 
         #endregion
-
+        /// <summary>
+        /// this method retrieves visitor information based on a provided mobile number from the database.
+        /// </summary>
+        /// <param name="srequest">This parameter of type SelectRequest represents the request object used for retrieving visitor information</param>
+        /// <param name="MobileNumber">the mobilenumber for which visitor information is to be retrieved.</param>
+        /// <returns>This method returns the response contains visitor information based on the provided mobile number.</returns>
         #region  Getting data from Visitors by Mobile Number
-        /** 
+        /* 
          * Get a single visitor record by mobile number 
          * @param SelectRequest srequest - the filer criteria 
          * @param string MobileNumber - the mobile number of the visitor that needs to be retrieved 
@@ -268,7 +328,12 @@ namespace Bizgaze.CRM.Visitors.Managers
             return await GetSingleAsync<Bizgaze.CRM.Visitors.Infos.Visitor>(srequest);
         }
         #endregion
-
+        /// <summary>
+        /// This method is used to get the install app id based on the visitorid.
+        /// </summary>
+        /// <param name="srequest">This parameter of type SelectRequest represents the request object used for retrieving visitor information.</param>
+        /// <param name="VisitorId">represents the VisitorId of the visitor for which information is to be retrieved.</param>
+        /// <returns>The method returns visitor information based on the provided visitor ID</returns>
         #region  Get installedAppId Async
         /*  
          This method is used to get the install app id based on the visitorid.  
@@ -284,7 +349,12 @@ namespace Bizgaze.CRM.Visitors.Managers
             return await GetSingleAsync<Bizgaze.CRM.Visitors.Infos.Visitor>(srequest);
         }
         #endregion
-
+        /// <summary>
+        /// Gets Visitors information with the given Visitor Id
+        /// </summary>
+        /// <param name="srequest">represents the request object used for retrieving visitor information.</param>
+        /// <param name="VisitorId">the unique identifier of the visitor for which information is to be retrieved.</param>
+        /// <returns>This method returns the response containing visitor information.The response contains visitor information based on the provided visitor ID.</returns>
         #region Get Visitor INformation
         // Gets Visitors information with the given Visitor Id.
         public async Task<SelectResponse<Bizgaze.CRM.Visitors.Infos.Visitor>> GetVisitorsAsync(SelectRequest srequest, long VisitorId)
@@ -296,7 +366,13 @@ namespace Bizgaze.CRM.Visitors.Managers
         }
 
         #endregion
-
+        /// <summary>
+        /// This method is used for capturing the image of the visitor.
+        /// </summary>
+        /// <param name="request">the request object containing information related to the action being performed</param>
+        /// <param name="obj">object containing dynamic properties representing the data to be saved. It likely contains the visitorid and the image</param>
+        /// <returns>This method returns If the image is successfully saved for the visitor, the method returns a success response with the message "Your Image Saved Successfully"
+        /// If there is an error during the image saving process, the method returns an error response.</returns>
         #region Save Visitor Image
         /* 
          *  ActionMethod Name: SaveVisitorImage