Leosac  0.8.0
Open Source Access Control
Leosac::Module::WebSockAPI::UserSearch Class Reference

Search Users by username. More...

#include <UserSearch.hpp>

+ Inheritance diagram for Leosac::Module::WebSockAPI::UserSearch:
+ Collaboration diagram for Leosac::Module::WebSockAPI::UserSearch:

Public Member Functions

 UserSearch (RequestContext ctx)
 
- Public Member Functions inherited from Leosac::Module::WebSockAPI::MethodHandler
 MethodHandler (RequestContext ctx)
 
virtual ~MethodHandler ()=default
 
json process (const ClientMessage &msg)
 The public process() method. More...
 
UserSecurityContextsecurity_context ()
 
ExecutionContext exec_context ()
 Returns a representation of the execution context of this request. More...
 

Static Public Member Functions

static MethodHandlerUPtr create (RequestContext)
 
- Static Public Member Functions inherited from Leosac::Module::WebSockAPI::MethodHandler
static MethodHandlerUPtr create (RequestContext)
 An example method that should be implemented in all subclasses. More...
 

Protected Member Functions

std::vector< ActionActionParamrequired_permission (const json &req) const override
 Return a list of "Action" / "ActionParam" that must pass before the request is processed. More...
 

Private Member Functions

virtual json process_impl (const json &req) override
 The API method implementation. More...
 

Additional Inherited Members

- Public Types inherited from Leosac::Module::WebSockAPI::MethodHandler
using Factory = MethodHandlerUPtr(*)(RequestContext)
 
- Protected Attributes inherited from Leosac::Module::WebSockAPI::MethodHandler
RequestContext ctx_
 

Detailed Description

Search Users by username.

Request:

  • 'partial_name': A part of the name we are looking for.

Response: A list of {id,username} for users that match the partial name. [ {id: $USER_ID, username: $USERNAME}, {...} ]

Definition at line 47 of file UserSearch.hpp.

Constructor & Destructor Documentation

◆ UserSearch()

UserSearch::UserSearch ( RequestContext  ctx)
explicit

Definition at line 29 of file UserSearch.cpp.

Member Function Documentation

◆ create()

MethodHandlerUPtr UserSearch::create ( RequestContext  ctx)
static

Definition at line 34 of file UserSearch.cpp.

◆ process_impl()

json UserSearch::process_impl ( const json req)
overrideprivatevirtual

The API method implementation.

Returns
A json object that will be assigned to the content key in the JSON message sent to the client.

Implements Leosac::Module::WebSockAPI::MethodHandler.

Definition at line 39 of file UserSearch.cpp.

◆ required_permission()

std::vector< ActionActionParam > UserSearch::required_permission ( const json req) const
overrideprotectedvirtual

Return a list of "Action" / "ActionParam" that must pass before the request is processed.

Implements Leosac::Module::WebSockAPI::MethodHandler.

Definition at line 45 of file UserSearch.cpp.


The documentation for this class was generated from the following files: