Class ConversationsApi

java.lang.Object

nl.bimbase.bimworks.client.apis.SubApi

nl.bimbase.bimworks.client.apis.ConversationsApi

public class ConversationsApi
extends SubApi

Conversations and comments anchored to a point (and optionally an object) in a model — the viewer's comment pins.

Constructor Summary

Constructors

Constructor	Description
ConversationsApi(BimWorksClient bimWorksClient)

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.node.ObjectNode	addComment(UUID conversationUuid, String message)
void	close(UUID conversationUuid)
void	delete(UUID conversationUuid)
com.fasterxml.jackson.databind.node.ArrayNode	list(Set<UUID> versionUuids)	Conversations on the given models the caller takes part in.
com.fasterxml.jackson.databind.node.ArrayNode	listComments(UUID conversationUuid)
void	reopen(UUID conversationUuid)
com.fasterxml.jackson.databind.node.ObjectNode	start(UUID versionUuid, double x, double y, double z, com.fasterxml.jackson.databind.node.ObjectNode qid, UUID otherUuid)	Start a conversation at a point in the model.

Methods inherited from class SubApi

getBimWorksClient

Modifier and Type	Method	Description
BimWorksClient	getBimWorksClient()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConversationsApi

public ConversationsApi(BimWorksClient bimWorksClient)

Method Details

start

public com.fasterxml.jackson.databind.node.ObjectNode start(UUID versionUuid,
 double x,
 double y,
 double z,
 com.fasterxml.jackson.databind.node.ObjectNode qid,
 UUID otherUuid)
                                                     throws BimWorksException

Start a conversation at a point in the model.

Parameters:

qid - the object the pin belongs to as {_vid, _oid}, or null for a free point

otherUuid - the account invited into the conversation, or null

Returns:

the conversation record

Throws:

BimWorksException

list

public com.fasterxml.jackson.databind.node.ArrayNode list(Set<UUID> versionUuids)
                                                   throws BimWorksException

Conversations on the given models the caller takes part in.

Throws:

BimWorksException

listComments

public com.fasterxml.jackson.databind.node.ArrayNode listComments(UUID conversationUuid)
                                                           throws BimWorksException

Throws:

BimWorksException

addComment

public com.fasterxml.jackson.databind.node.ObjectNode addComment(UUID conversationUuid,
 String message)
                                                          throws BimWorksException

Returns:

the comment record with the updated conversation under conversation

Throws:

BimWorksException

close

public void close(UUID conversationUuid)
           throws BimWorksException

Throws:

BimWorksException

reopen

public void reopen(UUID conversationUuid)
            throws BimWorksException

Throws:

BimWorksException

delete

public void delete(UUID conversationUuid)
            throws BimWorksException

Throws:

BimWorksException