Leosac
0.8.0
Open Source Access Control
|
Search Credentials by alias. More...
#include <CredentialSearch.hpp>
Public Member Functions | |
CredentialSearch (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... | |
UserSecurityContext & | security_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< ActionActionParam > | required_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_ |
Search Credentials by alias.
This API call is useful to provide type-ahead/autocomplete feature in the client.
The search is case insensitive.
Request:
Response: A list of {id,alias,type} for credentials that match the partial name. [ {id: $CREDENTIAL_ID, alias: $CREDENTIAL_ALIAS type: $CREDENTIAL_TYPE (Pin code / rfid card) }, {...} ]
Definition at line 54 of file CredentialSearch.hpp.
CredentialSearch::CredentialSearch | ( | RequestContext | ctx | ) |
Definition at line 32 of file CredentialSearch.cpp.
|
static |
Definition at line 37 of file CredentialSearch.cpp.
The API method implementation.
content
key in the JSON message sent to the client. Implements Leosac::Module::WebSockAPI::MethodHandler.
Definition at line 54 of file CredentialSearch.cpp.
|
overrideprotectedvirtual |
Return a list of "Action" / "ActionParam" that must pass before the request is processed.
Implements Leosac::Module::WebSockAPI::MethodHandler.
Definition at line 105 of file CredentialSearch.cpp.