Types | PrivMX Docs

BridgeIdentity

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

Fields

url

std::string

Bridge URL.

pubKey

std::optional< std::string >

Bridge public Key.

instanceId

std::optional< std::string >

Bridge instance Id given by PKI.

CollectionChangedEventData

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

Fields

moduleType

std::string

Type of the module

moduleId

std::string

ID of the module

affectedItemsCount

int64_t

Count of affected items

items

std::vector< CollectionItemChange >

List of item changes

CollectionItemChange

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

Fields

itemId

std::string

ID of the item

action

std::string

Item change action, which can be "create", "update" or "delete"

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

ContextUserEventData

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

Fields

contextId

std::string

ID of the Context

user

UserWithPubKey

User

ContextUsersStatusChangedEventData

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

Fields

contextId

std::string

ID of the Context

users

std::vector< UserWithAction >

List of users with their changed statuses

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

sortBy

std::optional< std::string >

field name to sort elements by

queryAsJson

std::optional< std::string >

extra query parameters in serialized JSON

PKIVerificationOptions

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

Fields

bridgePubKey

std::optional< std::string >

Bridge public Key.

bridgeInstanceId

std::optional< std::string >

Bridge instance Id given by PKI.

UserInfo

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

Fields

user

UserWithPubKey

User public key and their ID

isActive

bool

Determines whether the user is connected to Bridge

lastStatusChange

std::optional< UserStatusChange >

User last status change or no value if they have never logged in

UserStatusChange

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

Fields

action

std::string

User status change action, which can be "login" or "logout"

timestamp

int64_t

Timestamp of the change

UserWithAction

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

Fields

user

UserWithPubKey

User

action

std::string

User status change action, which can be "login" or "logout"

UserWithPubKey

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

Fields

userId

std::string

ID of the user

pubKey

std::string

user's public key