Types

ContainerPolicy

namespace: privmx::endpoint::core

Contains container and its items policies.

struct privmx::endpoint::core::ContainerPolicy{...} : ContainerPolicyWithoutItem

Fields

Name	Type	Description
item	std::optional< ItemPolicy >	Policy for container's items

ContainerPolicyWithoutItem

namespace: privmx::endpoint::core

Contains container's policies.

struct privmx::endpoint::core::ContainerPolicyWithoutItem{...}

Fields

Name	Type	Description
get	std::optional< std::string >	Determine who can get a container
update	std::optional< std::string >	Determine who can update a container
delete_	std::optional< std::string >	Determine who can delete a container
updatePolicy	std::optional< std::string >	Determine who can update policy
updaterCanBeRemovedFromManagers	std::optional< std::string >	Determine whether the updater can be removed from the list of managers
ownerCanBeRemovedFromManagers	std::optional< std::string >	Determine whether the owner can be removed from the list of managers

Context

namespace: privmx::endpoint::core

Contains base [Context](/reference/cpp/endpoint/core/types#context) information.

struct privmx::endpoint::core::Context{...}

Fields

Name	Type	Description
userId	std::string	ID of the user requesting information
contextId	std::string	ID of the Context

ItemPolicy

namespace: privmx::endpoint::core

Contains container items policies.

struct privmx::endpoint::core::ItemPolicy{...}

Fields

Name	Type	Description
get	std::optional< std::string >	Determine who can get an item
listMy	std::optional< std::string >	Determine who can list items created by me
listAll	std::optional< std::string >	Determine who can list all items
create	std::optional< std::string >	Determine who can create an item
update	std::optional< std::string >	Determine who can update an item
delete_	std::optional< std::string >	Determine who can delete an item

PagingList

namespace: privmx::endpoint::core

Contains results of listing methods.

struct privmx::endpoint::core::PagingList{...}

Fields

Name	Type	Description
totalAvailable	int64_t	total items available to get
readItems	std::vector< T >	list of items read during single method call

PagingQuery

namespace: privmx::endpoint::core

Contains query parameters for methods returning lists [PagingList](/reference/cpp/endpoint/core/types#paginglist)

struct privmx::endpoint::core::PagingQuery{...}

Fields

Name	Type	Description
skip	int64_t	number of elements to skip from result
limit	int64_t	limit of elements to return for query
sortOrder	std::string	order of elements in result ("asc" for ascending, "desc" for descending)
lastId	std::optional< std::string >	ID of the element from which query results should start

UserWithPubKey

namespace: privmx::endpoint::core

Contains ID of a user and the corresponding public key.

struct privmx::endpoint::core::UserWithPubKey{...}

Fields

Name	Type	Description
userId	std::string	ID of the user
pubKey	std::string	user's public key