PrivMX DOCS
API Reference/PrivMX Endpoint Java/Core

Core

BridgeIdentity

public class BridgeIdentity{
	String instanceId,
	String pubKey,
	String url
}

Fields

instanceId

String

Bridge instance Id given by PKI.

pubKey

String

Bridge public Key.

url

String

Bridge URL.

CollectionItemChange

public class CollectionItemChange{
	String action,
	String itemId
}

Fields

action

String

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

itemId

String

ID of the item.

ContainerPolicy

public class ContainerPolicy{
	ItemPolicy item
}

Fields

item

ItemPolicy

Policy for container's items.

ContainerPolicyWithoutItem

public class ContainerPolicyWithoutItem{
	String delete,
	String get,
	String ownerCanBeRemovedFromManagers,
	String update,
	String updatePolicy,
	String updaterCanBeRemovedFromManagers
}

Fields

delete

String

Determines who can delete a container.

get

String

Determines who can get a container.

ownerCanBeRemovedFromManagers

String

Determines whether the owner can be removed from the list of managers.

update

String

Determines who can update a container.

updatePolicy

String

Determines who can update policy.

updaterCanBeRemovedFromManagers

String

Determines whether the updater can be removed from the list of managers.

Context

public class Context{
	String contextId,
	String userId
}

Fields

contextId

String

ID of the Context.

userId

String

ID of the user requesting information.

ItemPolicy

public class ItemPolicy{
	String create,
	String delete,
	String get,
	String listAll,
	String listMy,
	String update
}

Fields

create

String

Determines who can create an item.

delete

String

Determines who can delete an item.

get

String

Determines who can get an item.

listAll

String

Determines who can list all items.

listMy

String

Determines who can list items created by themselves.

update

String

Determines who can update an item.

PKIVerificationOptions

public class PKIVerificationOptions{
	String bridgeInstanceId,
	String bridgePubKey
}

Fields

bridgeInstanceId

String

Bridge instance Id given by PKI.

bridgePubKey

String

Bridge public Key.

PagingList

public class PagingList<T>{
	List<T> readItems,
	Long totalAvailable
}

Fields

readItems

List<T>

List of items read during single method call.

totalAvailable

Long

Total items available to get.

UserInfo

public class UserInfo{
	boolean isActive,
	UserStatusChange lastStatusChange,
	UserWithPubKey user
}

Fields

isActive

boolean

is user connected to bridge

lastStatusChange

UserStatusChange

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

user

UserWithPubKey

User publicKey and userId

UserWithAction

public class UserWithAction{
	String action,
	UserWithPubKey user
}

Fields

action

String

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

user

UserWithPubKey

User.

UserWithPubKey

public class UserWithPubKey{
	String pubKey,
	String userId
}

Fields

pubKey

String

User's public key.

userId

String

ID of the user.

VerificationRequest

public class VerificationRequest{
	BridgeIdentity bridgeIdentity,
	String contextId,
	Long date,
	String senderId,
	String senderPubKey
}

Fields

bridgeIdentity

BridgeIdentity

Bridge Identity

contextId

String

Id of the Context

date

Long

The data creation date

senderId

String

id of the sender

senderPubKey

String

Public key of the sender

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

PrivMX Endpoint Java v2.6

This package is not up to date with the core documentation. Some of the features you've seen described in other parts of the documentation might not be mentioned here. Those changes do not influence compatibility, however
Core | PrivMX Docs