Skip to main content

Core

ContainerPolicy

Contains container and its items policies.

public class ContainerPolicy{
ItemPolicy item
}

Fields

NameTypeDescription
itemItemPolicyPolicy for container's items.

ContainerPolicyWithoutItem

Contains container's policies.

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

Fields

NameTypeDescription
deleteStringDetermines who can delete a container.
getStringDetermines who can get a container.
ownerCanBeRemovedFromManagersStringDetermines whether the owner can be removed from the list of managers.
updateStringDetermines who can update a container.
updatePolicyStringDetermines who can update policy.
updaterCanBeRemovedFromManagersStringDetermines whether the updater can be removed from the list of managers.

Context

Contains base Context information.

public class Context{
String contextId,
String userId
}

Fields

NameTypeDescription
contextIdStringID of the Context.
userIdStringID of the user requesting information.

ItemPolicy

Contains container items policies.

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

Fields

NameTypeDescription
createStringDetermines who can create an item.
deleteStringDetermines who can delete an item.
getStringDetermines who can get an item.
listAllStringDetermines who can list all items.
listMyStringDetermines who can list items created by themselves.
updateStringDetermines who can update an item.

PagingList

Contains results of listing methods.

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

Fields

NameTypeDescription
readItemsList<T>List of items read during single method call.
totalAvailableLongTotal items available to get.

UserWithPubKey

Contains ID of user and the corresponding public key.

public class UserWithPubKey{
String pubKey,
String userId
}

Fields

NameTypeDescription
pubKeyStringUser's public key.
userIdStringID of the user.