practicekea_backend/microservices/user/bin/net9.0/API.User.xml

163 lines
7.4 KiB
XML
Raw Normal View History

2024-12-02 13:24:34 +00:00
<?xml version="1.0"?>
<doc>
<assembly>
<name>API.User</name>
</assembly>
<members>
<member name="T:OnlineAssessment.SwaggerConfigureOptions">
<summary>
Configures the Swagger generation options.
</summary>
<remarks>This allows API versioning to define a Swagger document per API version after the
<see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiVersionDescriptionProvider"/> service has been resolved from the service container.</remarks>
</member>
<member name="M:OnlineAssessment.SwaggerConfigureOptions.#ctor(Microsoft.AspNetCore.Mvc.ApiExplorer.IApiVersionDescriptionProvider)">
<summary>
Initializes a new instance of the <see cref="T:OnlineAssessment.SwaggerConfigureOptions"/> class.
</summary>
<param name="provider">The <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiVersionDescriptionProvider">provider</see> used to generate Swagger documents.</param>
</member>
<member name="M:OnlineAssessment.SwaggerConfigureOptions.Configure(Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions)">
<inheritdoc />
</member>
<member name="T:OnlineAssessment.SwaggerDefaultValues">
<summary>
Represents the Swagger/Swashbuckle operation filter used to document the implicit API version parameter.
</summary>
<remarks>This <see cref="T:Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter"/> is only required due to bugs in the <see cref="T:Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator"/>.
Once they are fixed and published, this class can be removed.</remarks>
</member>
<member name="M:OnlineAssessment.SwaggerDefaultValues.Apply(Microsoft.OpenApi.Models.OpenApiOperation,Swashbuckle.AspNetCore.SwaggerGen.OperationFilterContext)">
<summary>
Applies the filter to the specified operation using the given context.
</summary>
<param name="operation">The operation to apply the filter to.</param>
<param name="context">The current operation filter context.</param>
</member>
<member name="M:OnlineAssessment.V1.Controllers.UsersController.SignIn">
<summary>
Admin/ Teacher Log in
</summary>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V1.Controllers.UsersController.AddAdminTeacher(OnlineAssessment.Domain.ViewModels.AddAdminTeacherModel)">
<summary>
Add Admin/Teacher
</summary>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V1.Controllers.UsersController.GetAll">
<summary>
Get All Users (accessible to SuperAdmin only)
</summary>
<returns>All Users of all the institutes</returns>
</member>
<member name="M:OnlineAssessment.V1.Controllers.UsersController.Get(System.Int32)">
<summary>
Get details of an user (accessible to SuperAdmin only)
</summary>
<param name="id">Id of the user</param>
<returns>The user's information</returns>
</member>
<member name="M:OnlineAssessment.V1.Controllers.UsersController.Put(System.Int32,OnlineAssessment.Domain.ViewModels.UserEditModel)">
<summary>
Edit an user (accessible to SuperAdmin only)
</summary>
<param name="id">The id of the user to edit</param>
<param name="userEdit">User's data to edit</param>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V1.Controllers.UsersController.Delete(System.Int32)">
<summary>
Delete a record (accessible to SuperAdmin only)
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V1.Controllers.UsersController.UpdatePreference(System.String)">
<summary>
Update language
</summary>
<param name="language"></param>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V1.Controllers.UsersController.AttachMeToUserGroup(System.Int32,OnlineAssessment.Domain.ViewModels.DefaultGroup)">
<summary>
Attch me to usergroup
</summary>
<param name="user_group_id"></param>
<param name="defaultGroup"></param>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V1.Controllers.UsersController.DetachUserGroup(System.Int32)">
<summary>
Detach user group of a user
</summary>
<param name="user_group_id"></param>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V1.Controllers.BaseController`2.GetAll">
<summary>
Get list of the records for this entity
</summary>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V1.Controllers.BaseController`2.Get(System.Int32)">
<summary>
Get a specific record by id
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V2.Controllers.UsersController.SignIn">
<summary>
Admin/ Teacher Log in
</summary>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V2.Controllers.UsersController.AddAdminTeacher(OnlineAssessment.Domain.ViewModels.AddAdminTeacherModel)">
<summary>
Add Admin/Teacher
</summary>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V2.Controllers.UsersController.Put(System.Int32,OnlineAssessment.Domain.ViewModels.UserEditModel)">
<summary>
Edit an user (accessible to SuperAdmin only)
</summary>
<param name="id">The id of the user to edit</param>
<param name="userEdit">User's data to edit</param>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V2.Controllers.UsersController.Delete(System.Int32)">
<summary>
Delete a record (accessible to SuperAdmin only)
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V2.Controllers.UsersController.UpdatePreference(System.String)">
<summary>
Update language
</summary>
<param name="language"></param>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V2.Controllers.UsersController.AttachMeToUserGroup(System.Int32,OnlineAssessment.Domain.ViewModels.DefaultGroup)">
<summary>
Attch me to usergroup
</summary>
<param name="user_group_id"></param>
<param name="defaultGroup"></param>
<returns></returns>
</member>
<member name="M:OnlineAssessment.V2.Controllers.UsersController.DetachUserGroup(System.Int32)">
<summary>
Detach user group of a user
</summary>
<param name="user_group_id"></param>
<returns></returns>
</member>
</members>
</doc>