#include <privmx/endpoint/thread/ThreadApi.hpp>

Inheritance diagram for privmx::endpoint::thread::ThreadApi:

Collaboration diagram for privmx::endpoint::thread::ThreadApi:

Public Member Functions
	ThreadApi ()
	ThreadApi (const ThreadApi &obj)
ThreadApi &	operator= (const ThreadApi &obj)
	ThreadApi (ThreadApi &&obj)
std::string	createThread (const std::string &contextId, const std::vector< core::UserWithPubKey > &users, const std::vector< core::UserWithPubKey > &managers, const core::Buffer &publicMeta, const core::Buffer &privateMeta, const std::optional< core::ContainerPolicy > &policies=std::nullopt)
void	updateThread (const std::string &threadId, const std::vector< core::UserWithPubKey > &users, const std::vector< core::UserWithPubKey > &managers, const core::Buffer &publicMeta, const core::Buffer &privateMeta, const int64_t version, const bool force, const bool forceGenerateNewKey, const std::optional< core::ContainerPolicy > &policies=std::nullopt)
void	deleteThread (const std::string &threadId)
Thread	getThread (const std::string &threadId)
core::PagingList< Thread >	listThreads (const std::string &contextId, const core::PagingQuery &pagingQuery)
Message	getMessage (const std::string &messageId)
core::PagingList< Message >	listMessages (const std::string &threadId, const core::PagingQuery &pagingQuery)
std::string	sendMessage (const std::string &threadId, const core::Buffer &publicMeta, const core::Buffer &privateMeta, const core::Buffer &data)
void	deleteMessage (const std::string &messageId)
void	updateMessage (const std::string &messageId, const core::Buffer &publicMeta, const core::Buffer &privateMeta, const core::Buffer &data)
std::vector< std::string >	subscribeFor (const std::vector< std::string > &subscriptionQueries)
void	unsubscribeFrom (const std::vector< std::string > &subscriptionIds)
std::string	buildSubscriptionQuery (EventType eventType, EventSelectorType selectorType, const std::string &selectorId)
Public Member Functions inherited from privmx::endpoint::core::ExtendedPointer< ThreadApiImpl >
ExtendedPointer &	operator= (const ExtendedPointer &obj)
std::shared_ptr< ThreadApiImpl >	getImpl () const

Static Public Member Functions
static ThreadApi	create (core::Connection &connetion)

Additional Inherited Members
Protected Member Functions inherited from privmx::endpoint::core::ExtendedPointer< ThreadApiImpl >
void	attachToPtrIfPossible ()
void	detachFromPtrIfPossible ()
Protected Attributes inherited from privmx::endpoint::core::ExtendedPointer< ThreadApiImpl >
std::weak_ptr< ThreadApiImpl >	_ptr

Detailed Description

'ThreadApi' is a class representing Endpoint's API for Threads and their messages.

Constructor & Destructor Documentation

◆ ThreadApi()

privmx::endpoint::thread::ThreadApi::ThreadApi ( )

//doc-gen:ignore

Member Function Documentation

◆ buildSubscriptionQuery()

std::string privmx::endpoint::thread::ThreadApi::buildSubscriptionQuery	(	EventType	eventType,
		EventSelectorType	selectorType,
		const std::string &	selectorId )

Generate subscription Query for the Thread events.

Parameters

eventType	type of event which you listen for
selectorType	scope on which you listen for events
selectorId	ID of the selector

◆ create()

ThreadApi privmx::endpoint::thread::ThreadApi::create ( core::Connection & connetion )

static

Creates an instance of 'ThreadApi'.

Parameters

connection instance of 'Connection'

Returns: ThreadApi object

◆ createThread()

std::string privmx::endpoint::thread::ThreadApi::createThread	(	const std::string &	contextId,
		const std::vector< core::UserWithPubKey > &	users,
		const std::vector< core::UserWithPubKey > &	managers,
		const core::Buffer &	publicMeta,
		const core::Buffer &	privateMeta,
		const std::optional< core::ContainerPolicy > &	policies = std::nullopt )

Creates a new Thread in given Context.

Parameters

contextId	ID of the Context to create the Thread in
users	vector of UserWithPubKey structs which indicates who will have access to the created Thread
managers	vector of UserWithPubKey structs which indicates who will have access (and management rights) to the created Thread
publicMeta	public (unencrypted) metadata
privateMeta	private (encrypted) metadata
policies	Thread's policies

Returns: ID of the created Thread

◆ deleteMessage()

void privmx::endpoint::thread::ThreadApi::deleteMessage ( const std::string & messageId )

Deletes a message by given message ID.

Parameters

messageId ID of the message to delete

◆ deleteThread()

void privmx::endpoint::thread::ThreadApi::deleteThread ( const std::string & threadId )

Deletes a Thread by given Thread ID.

Parameters

threadId ID of the Thread to delete

◆ getMessage()

Message privmx::endpoint::thread::ThreadApi::getMessage ( const std::string & messageId )

Gets a message by given message ID.

Parameters

ID	of the message to get

Returns: struct containing the message

◆ getThread()

Thread privmx::endpoint::thread::ThreadApi::getThread ( const std::string & threadId )

Gets a Thread by given Thread ID.

Parameters

threadId ID of Thread to get

Returns: Thread struct containing info about the Thread

◆ listMessages()

core::PagingList< Message > privmx::endpoint::thread::ThreadApi::listMessages	(	const std::string &	threadId,
		const core::PagingQuery &	pagingQuery )

Gets a list of messages from a Thread.

Parameters

threadId	ID of the Thread to list messages from
pagingQuery	struct with list query parameters

Returns: struct containing a list of messages

◆ listThreads()

core::PagingList< Thread > privmx::endpoint::thread::ThreadApi::listThreads	(	const std::string &	contextId,
		const core::PagingQuery &	pagingQuery )

Gets a list of Threads in given Context.

Parameters

contextId	ID of the Context to get the Threads from
pagingQuery	struct with list query parameters

Returns: struct containing a list of Threads

◆ sendMessage()

std::string privmx::endpoint::thread::ThreadApi::sendMessage	(	const std::string &	threadId,
		const core::Buffer &	publicMeta,
		const core::Buffer &	privateMeta,
		const core::Buffer &	data )

Sends a message in a Thread.

Parameters

threadId	ID of the Thread to send message to
publicMeta	public message metadata
privateMeta	private message metadata
data	content of the message

Returns: ID of the new message

◆ subscribeFor()

std::vector< std::string > privmx::endpoint::thread::ThreadApi::subscribeFor ( const std::vector< std::string > & subscriptionQueries )

Subscribe for the Thread events on the given subscription query.

Parameters

subscriptionQueries list of queries

Returns: list of subscriptionIds in maching order to subscriptionQueries

◆ unsubscribeFrom()

void privmx::endpoint::thread::ThreadApi::unsubscribeFrom ( const std::vector< std::string > & subscriptionIds )

Unsubscribe from events for the given subscriptionId.

Parameters

subscriptionIds list of subscriptionId

◆ updateMessage()

void privmx::endpoint::thread::ThreadApi::updateMessage	(	const std::string &	messageId,
		const core::Buffer &	publicMeta,
		const core::Buffer &	privateMeta,
		const core::Buffer &	data )

Update message in a Thread.

Parameters

messageId	ID of the message to update
publicMeta	public message metadata
privateMeta	private message metadata
data	content of the message

◆ updateThread()

void privmx::endpoint::thread::ThreadApi::updateThread	(	const std::string &	threadId,
		const std::vector< core::UserWithPubKey > &	users,
		const std::vector< core::UserWithPubKey > &	managers,
		const core::Buffer &	publicMeta,
		const core::Buffer &	privateMeta,
		const int64_t	version,
		const bool	force,
		const bool	forceGenerateNewKey,
		const std::optional< core::ContainerPolicy > &	policies = std::nullopt )

Updates an existing Thread.

Parameters

threadId	ID of the Thread to update
users	vector of UserWithPubKey structs which indicates who will have access to the created Thread
managers	vector of UserWithPubKey structs which indicates who will have access (and management rights) to the created Thread
publicMeta	public (unencrypted) metadata
privateMeta	private (encrypted) metadata
version	current version of the updated Thread
force	force update (without checking version)
forceGenerateNewKey	force to regenerate a key for the Thread
policies	Thread's policies

The documentation for this class was generated from the following file:

privmx/endpoint/thread/ThreadApi.hpp

PrivMX DOCS PrivMX Endpoint v2.7.0

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ThreadApi()

Member Function Documentation

◆ buildSubscriptionQuery()

◆ create()

◆ createThread()

◆ deleteMessage()

◆ deleteThread()

◆ getMessage()

◆ getThread()

◆ listMessages()

◆ listThreads()

◆ sendMessage()

◆ subscribeFor()

◆ unsubscribeFrom()

◆ updateMessage()

◆ updateThread()