API Docs for version 1.2.7300

ParticipantCriteria

Module: Circuit.Enums
Parent Module: Circuit

static

Summary

Enum for a Participant Type.

Item Index

Properties

Properties

DISPLAY_NAME

Syntax

DISPLAY_NAME

String static

Summary

The display name of the search string (e.g. participant). Searches like are allowed and would return accounts of users with display name and for example.

FORMER

Syntax

FORMER

String static

Summary

Former participant, i.e. the user was memeber of the conversation but has left it or was removed.

GUEST

Syntax

GUEST

String static

Summary

Guest participant, i.e. user of a different tenant compared to the tenant in which this conversation was created.

MODERATOR

Syntax

MODERATOR

String static

Summary

Special type in case the conversation is moderaded and this participant has the moderation rights.

REGULAR

Syntax

REGULAR

String static

Summary

Regular default participant of a conversation.

TYPE

Syntax

TYPE

String static

Summary

The participant type. Supported values are REGULAR, FORMER, MODERATOR, GUEST or ACTIVE where active means all participants which are not of type FORMER.