lintel 0.2.0
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
lintel::UsersPageDto Class Reference

#include <UserDto.h>

Inheritance diagram for lintel::UsersPageDto:
lintel::JsonSerializable

Public Member Functions

 UsersPageDto (const Page< User > &page)
 
 UsersPageDto ()=default
 
void serialize (rapidjson::Writer< rapidjson::StringBuffer > *writer) const override
 
bool deserialize (const rapidjson::Value &obj) override
 
const std::vector< UserDto > & getUsers () const
 
bool hasMore () const
 
const std::optional< std::string > & getNextAfter () const
 
- Public Member Functions inherited from lintel::JsonSerializable
 JsonSerializable ()=default
 
virtual ~JsonSerializable ()=default
 
virtual std::string serialize () const
 
virtual void deserialize (const std::string &json)
 

Detailed Description

DTO representing a single page of keyset-paginated users

Constructor & Destructor Documentation

◆ UsersPageDto() [1/2]

lintel::UsersPageDto::UsersPageDto ( const Page< User > &  page)
explicit

Construct from a paginated result

Parameters
pageThe page of users

◆ UsersPageDto() [2/2]

lintel::UsersPageDto::UsersPageDto ( )
default

Default constructor

Member Function Documentation

◆ deserialize()

bool lintel::UsersPageDto::deserialize ( const rapidjson::Value &  obj)
overridevirtual

Deserialize from JSON

Parameters
objThe JSON value
Returns
True on success

Reimplemented from lintel::JsonSerializable.

◆ getNextAfter()

const std::optional< std::string > & lintel::UsersPageDto::getNextAfter ( ) const
Returns
the continuation key for the next page, if any

◆ getUsers()

const std::vector< UserDto > & lintel::UsersPageDto::getUsers ( ) const

Get the user DTOs of this page

Returns
Vector of user DTOs

◆ hasMore()

bool lintel::UsersPageDto::hasMore ( ) const
Returns
true if more pages follow

◆ serialize()

void lintel::UsersPageDto::serialize ( rapidjson::Writer< rapidjson::StringBuffer > *  writer) const
overridevirtual

Serialize to JSON

Parameters
writerThe rapidjson writer

Implements lintel::JsonSerializable.


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