API Docs for version 1.2.6900

SearchScope

Module: Circuit.Enums
Parent Module: Circuit

static

Summary

Enum for the search scopes

Item Index

Properties

Properties

ALL

Syntax

ALL

String static

Summary

Global scope to search in all scopes.

CONVERSATIONS

Syntax

CONVERSATIONS

String static

Summary

Search a name of a conversation.

DATE

Syntax

DATE

String static

Summary

Search for messages between the given optional startTime and optional endTime dates.

FILES

Syntax

FILES

String static

Summary

Search for a filename in a conversation.

FILTER

Syntax

FILTER

String static

Summary

Search based on the definition of a filter as defined in rootConnector.

LABEL

Syntax

LABEL

String static

Summary

Search for conversation with a given label

MEMBERS

Syntax

MEMBERS

String static

Summary

Search for member of a group or direct conversation. Members scoping cannot be combined with People scoping. Multiple Members scoping is possible, but in that case, the terms must match members of a single group conversation.

PEOPLE

Syntax

PEOPLE

String static

Summary

Search for user in a direct conversations. Only one People scoping in a single search and cannot be combined with Members scoping.

SENT_BY

Syntax

SENT_BY

String static

Summary

Search the creator of a message.