API Docs for version 1.3.1810

ConversationSearchResult

Module: Circuit

Summary

Object defining the Conversation Search Results used in BasicSearchResultEvent and DetailedSearchResultEvent.

Properties

convId

Syntax

convId

String

Summary

The id of the conversation that contains one or more matches

convItemsMatchedIds

Syntax

convItemsMatchedIds

String[]

Summary

A list of conversation item IDs that have matches for the query

filesMatchedIds

Syntax

filesMatchedIds

String[]

Summary

A list of conversation file IDs that have matches for the query

memberMatched

Syntax

memberMatched

Boolean

Summary

Flag to indicate if at least one participant matches the search query

searchThreadContexts

Syntax

searchThreadContexts

SearchThreadContext[]

Summary

A list of thread contexts that have matches for the query