PrivMX DOCS
API Reference/PrivMX Endpoint/Core

Types

ContainerPolicy

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

Fields

item

std::optional< ItemPolicy >

Policy for container's items

ContainerPolicyWithoutItem

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

Fields

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

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

Fields

userId

std::string

ID of the user requesting information

contextId

std::string

ID of the Context

ItemPolicy

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

Fields

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

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

Fields

totalAvailable

int64_t

total items available to get

readItems

std::vector< T >

list of items read during single method call

PagingQuery

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

Fields

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

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

Fields

userId

std::string

ID of the user

pubKey

std::string

user's public key

We use cookies on our website. We use them to ensure the proper functioning of the site and, if you agree, for purposes we set, such as analytics or marketing.