Referência à classe WebAPI.Controllers.UserController

Controller de Usuário. Mais...

Diagrama de heranças da classe WebAPI.Controllers.UserController

Diagrama de colaboração para WebAPI.Controllers.UserController:

Membros públicos
	UserController (IActivateUser activateUser, IDeactivateUser deactivateUser, IGetActiveUsers getActiveUsers, IGetInactiveUsers getInactiveUsers, IGetUserById getUserById, IUpdateUser updateUser, IMakeAdmin makeAdmin, IMakeCoordinator makeCoordinator, ILogger< UserController > logger)
	Construtor do Controller de Usuário. Mais...
async Task< ActionResult< UserReadOutput > >	GetById (Guid? id)
	Obtém usuário pelo id. Mais...
async Task< ActionResult< IEnumerable< UserReadOutput > > >	GetAllActive (int skip=0, int take=50)
	Obtém todos os usuários ativos. Mais...
async Task< ActionResult< IEnumerable< UserReadOutput > > >	GetAllInactive (int skip=0, int take=50)
	Obtém todos os usuários inativos. Mais...
async Task< ActionResult< UserReadOutput > >	Update ([FromBody] UserUpdateInput request)
	Atualiza usuário autenticado. Mais...
async Task< ActionResult< UserReadOutput > >	Activate (Guid? userId)
	Ativa usuário pelo Id. Mais...
async Task< ActionResult< UserReadOutput > >	Deactivate (Guid? userId)
	Desativa usuário pelo Id. Mais...
async Task< ActionResult< UserReadOutput > >	MakeAdmin (Guid? userId)
	Torna usuário administrador pelo Id. Mais...
async Task< ActionResult< UserReadOutput > >	MakeCoordinator (Guid? userId)
	Torna usuário coordenador pelo Id. Mais...

Descrição detalhada

Controller de Usuário.

Documentação dos Construtores & Destrutor

UserController()

WebAPI.Controllers.UserController.UserController ( IActivateUser  activateUser, IDeactivateUser  deactivateUser, IGetActiveUsers  getActiveUsers, IGetInactiveUsers  getInactiveUsers, IGetUserById  getUserById, IUpdateUser  updateUser, IMakeAdmin  makeAdmin, IMakeCoordinator  makeCoordinator, ILogger< UserController >  logger  )

inline

Construtor do Controller de Usuário.

Parâmetros

activateUser	Ativa usuário.
deactivateUser	Desativa usuário.
getActiveUsers	Obtém todos os usuários ativos.
getInactiveUsers	Obtém todos os usuários inativos.
getUserById	Obtém usuário pelo id.
updateUser	Atualiza usuário.
makeAdmin	Torna usuário administrador.
makeCoordinator	Torna usuário coordenador.
logger	Logger.

Documentação dos métodos

Activate()

async Task<ActionResult<UserReadOutput> > WebAPI.Controllers.UserController.Activate ( Guid?  userId )

inline

Ativa usuário pelo Id.

Parâmetros

userId

Id do usuário.

Retorna

Usuário ativado.

<response code="200">Usuário ativado.</response> <response code="400">Id não informado.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Usuário não encontrado.</response>

Deactivate()

async Task<ActionResult<UserReadOutput> > WebAPI.Controllers.UserController.Deactivate ( Guid?  userId )

inline

Desativa usuário pelo Id.

Parâmetros

userId

Id do usuário.

Retorna

Usuário desativado.

<response code="200">Usuário desativado.</response> <response code="400">Id não informado.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Usuário não encontrado.</response>

GetAllActive()

async Task<ActionResult<IEnumerable<UserReadOutput> > > WebAPI.Controllers.UserController.GetAllActive ( int  skip = 0, int  take = 50  )

inline

Obtém todos os usuários ativos.

Parâmetros

skip	Quantidade de registros a serem ignorados.
take	Quantidade de registros a serem retornados.

Retorna

Usuários ativos.

<response code="200">Usuários encontrados.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Usuários não encontrados.</response>

GetAllInactive()

async Task<ActionResult<IEnumerable<UserReadOutput> > > WebAPI.Controllers.UserController.GetAllInactive ( int  skip = 0, int  take = 50  )

inline

Obtém todos os usuários inativos.

Parâmetros

skip	Quantidade de registros a serem ignorados.
take	Quantidade de registros a serem retornados.

Retorna

Usuários inativos.

<response code="200">Usuários encontrados.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Usuários não encontrados.</response>

GetById()

async Task<ActionResult<UserReadOutput> > WebAPI.Controllers.UserController.GetById ( Guid?  id )

inline

Obtém usuário pelo id.

Parâmetros

id	Id do usuário.

Retorna

Usuário encontrado.

<response code="200">Usuário encontrado.</response> <response code="400">Id não informado.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Usuário não encontrado.</response>

MakeAdmin()

async Task<ActionResult<UserReadOutput> > WebAPI.Controllers.UserController.MakeAdmin ( Guid?  userId )

inline

Torna usuário administrador pelo Id.

Parâmetros

userId

Id do usuário.

Retorna

Resultado da operação.

<response code="200">Usuário administrador.</response> <response code="400">Id não informado.</response> <response code="401">Usuário não autorizado.</response>

MakeCoordinator()

async Task<ActionResult<UserReadOutput> > WebAPI.Controllers.UserController.MakeCoordinator ( Guid?  userId )

inline

Torna usuário coordenador pelo Id.

Parâmetros

userId

Id do usuário.

Retorna

Resultado da operação.

<response code="200">Usuário coordenador.</response> <response code="400">Id não informado.</response> <response code="401">Usuário não autorizado.</response>

Update()

async Task<ActionResult<UserReadOutput> > WebAPI.Controllers.UserController.Update ( [FromBody] UserUpdateInput  request )

inline

Atualiza usuário autenticado.

Parâmetros

request

Dados do usuário.

Retorna

Usuário atualizado.

<response code="200">Usuário atualizado.</response> <response code="400">Dados inválidos.</response> <response code="401">Usuário não autorizado.</response>

---

A documentação para esta classe foi gerada a partir do seguinte ficheiro:

• src/Infrastructure/WebAPI/Controllers/UserController.cs