All Classes and Interfaces

Class
Description
 
Base abstract class for activities provided by the BDK.
Abstract class to factorize the BotAuthenticator logic between RSA and certificate, especially the retry logic on top of HTTP calls.
Abstract class to factorize the ExtensionAppAuthenticator logic between RSA and certificate, especially the retry logic on top of HTTP calls.
Abstract class to factorize the OboAuthenticator logic between RSA and certificate, especially the retry logic on top of HTTP calls.
An object containing the ackId (and parameters) associated with events that the client has received through an individual feed.
Base class for an activity context holder.
AbstractActivity information/documentation model.
An activity matcher allows to check if an activity business logic has to be triggered or not.
This class allows to bind an AbstractActivity to the Real Time Events source, or Datafeed.
Type of an activity.
AdminJustifiedAction
AdminJustifiedUserAction
additional optional properties for the stream
stream filter criteria
Origin of the room.
Privacy setting of the stream.
scope of the room.
Status of the room.
Stream information
list of streams info
AdminStreamTypeEnum
Gets or Sets type
AgentInfo
Factory responsible for creating ApiClient instances for each main Symphony's components : Agent KeyManager Pod
Deprecated.
to be removed if we want to move retry to another module
Exception thrown when initializing the ApiClient.
App RSA key information.
App RSA keys information.
Extension App Authentication session handle.
AppAuthSession implementation for certificate extension app authentication mode.
AppAuthSession impl for rsa extension app authentication mode.
 
 
Detailed record of application.
Required information for creating an application.
Service class for managing the applications and the application entitlements.
Application callback information
Application configuration property that is shared with the extension application, client side.
Interface representing a slash command token which is an argument, like {argument}.
Class storing arguments matching a SlashCommandPattern
Assignee Candidate
List of assignee candidate
Attachment model to be used in Message.MessageBuilder to attach a file to a Message
AttachmentInfo
Preview file for image attachments
 
The list of available sort order for looking up the attachments.
 
Request body for extension app authentication
Request body for pubkey authentication
 
Factory class that provides new instances for the main authenticators : BotAuthenticator : to authenticate the main Bot service account OboAuthenticator : to perform on-behalf-of authentication
Thrown when unable to read/parse a RSA Private Key or a certificate.
Authentication session handle.
AuthSession impl for regular authentication mode.
AuthSession impl for OBO Certificate authentication mode.
AuthSession impl for OBO authentication mode.
When thrown, it means that authentication cannot be performed for several reasons depending on the context : Regular Bot authentication OBO authentication
Avatar
AvatarUpdate
BaseMessage
BaseSignal
Interface to be implemented by any BdkExtension that wishes to use the ApiClientFactory.
Interface to be implemented by any BdkExtension that wishes to use the AuthSession of the bot service account.
Custom BdkExponentialFunction class to be used in Bdk Retry mechanism.
 
Interface to be implemented by any BdkExtension that wishes to benefit from the BDK HTTP Retry logic.
Bot authenticator service.
Bot authenticator certificate implementation.
Bot authenticator RSA implementation.
The results of list based bulk action.
Gets or Sets overallResult
Class representing a cashtag in a V4Message
 
 
CertInfoItem
ChannelSubscriber
ChannelSubscriberResponse
ChannelSubscriptionError
ChannelSubscriptionResponse
A form reply activity corresponds to any message send in a chat where the bot is part of.
Default implementation of the ActivityContext handled by the CommandActivity.
Interface representing one token in a slash command pattern
CompanyCert
CompanyCertAttributes
CompanyCertDetail
CompanyCertInfo
CompanyCertStatus
Gets or Sets type
CompanyCertType
Gets or Sets type
 
Generated when a connection request is sent.
ConnectionRequestMessageAllOf
Service class for managing connection status.
The list of all possible values for the request listing connection status.
Functional interface which may throw a Throwable.
ConversationSpecificStreamAttributes
Interface which abstracts a cursor-based paginated endpoint.
 
Interface describing a given page of data returned by a cursor-based paginated endpoint.
Pagination Attribute model to be used in default pagination methods provided by bdk services class.
Datafeed
 
A repository interface for storing a datafeed id.
Concrete implementation of LoadBalancedApiClient used in datafeed services where LoadBalancedApiClient.rotate() is executed only when explicitly called.
Interface definition for a loop service to be used for handling the datafeed API.
A class for implementing the datafeed v1 loop service.
A class for implementing the datafeed v2 loop service.
Options of datafeed version can be used.
Interface definition for a loop service to be used for handling the datahose API.
 
 
DelegateAction
Gets or Sets action
Class to log deprecation message using "deprecation" logger
Disclaimer
Gets or Sets format
 
Service class for managing disclaimers.
 
DownloadReceiptCount
Enum representing the different entity types in the V4Message.getData().
Error
A particular exception to throw from RealTimeEventListener implementations to explicitly indicate that the event processing has failed and that all the events received in the datafeed read events call should be re-queued.
The real time event payload type.
Request body for extension app authentication
Extension App Authenticator Service.
Extension app authenticator Cert implementation.
Extension app authenticator RSA implementation.
ExtensionAppTokens
Repository to store (appToken, symphonyToken) entries corresponding to extensionApp authentications.
Service class for managing extensions.
The LoadBalancingStrategy corresponding to the BdkLoadBalancingMode.EXTERNAL mode.
An object respresenting the result count of faceted search.
This exception can be triggered when a fatal error occurred during an activity execution flow.
Entitlement feature record.
FileExtension
File extension with metadata understood by the system or file extension created by a customer
FileExtensionsResponse
FollowersList
FollowersListResponse
FollowingListResponse
A form reply activity corresponds to an Elements form submission.
Default implementation of the ActivityContext handled by the FormReplyActivity.
Information Barrier Group record.
GroupItem
User Group info to include in other models
Class representing a hashtag in a V4Message
Service class for checking health of the Agent server.
A help command listing all the commands that can be performed by an end-user through the chat.
Helper class providing Base64 id conversion.
These attributes cannot be changed once the room has been created
A historic message to be imported into the system.
Gets or Sets format
ImportResponse
IMSystemInfo
 
 
Class responsible for parsing a V4Message into a list of tokens separated by at least one whitespace character.
Jwks
JWT helper class, used to : load a private key generated a signed JWT for a given user
JwtToken
List of languages
An ApiClient implementation which load balances calls across several base URLs.
Interface to provide a load balancing strategy, i.e.
Class to instantiate LoadBalancingStrategy instances according to a specific BdkConfig.
CommandToken which matches message token if it is a mention with a given user ID.
Class representing the outcome of a matching between a SlashCommandPattern and a V4Message.
Detailed membership record.
User object response
Class representing a mention in a V4Message.
Message model to be used in MessageService.send(V4Stream, Message)
A representation of a message sent by a user of Symphony.
Message class builder.
MessageAllOf
 
Exception thrown when a Message is failed to create.
Message detail
MessageDownloadReceiptCount
MessageIds
List of MessageIds of a Stream
Message metadata
MessageMetadataResponseParent
Gets or Sets relationshipType
Helper class for extracting entities inside an incoming V4Message such as: Mentions, Hashtags, Cashtags, Emojis.
Exception thrown when the MessageParser fails to parse data inside the message.
Message receipt details response object
List of Message receipt details
 
MessageSearchQuery
Service class for managing messages.
Holds the status of a particular message, indicating which user the message has been sent, delivered or read.
MessageStatusUser
MessageStream
MessageSubmission
Gets or Sets format
 
The suppression state of a message
MessageUser
Helper class for pre-processing an outgoing message
NameValuePair
Exception thrown when recovery strategy in a RetryWithRecovery failed.
 
 
On-behalf-of authenticator service.
OBO Certificate authenticator implementation
OBO authenticator RSA implementation.
OboAuthResponse
Service interface exposing OBO-enabled endpoints to manage user connection status.
Service interface exposing OBO-enabled endpoints to manage messages.
Service interface exposing OBO-enabled endpoints to manage user presence information.
Interface which returns an OBO-enabled service class from a given OBO session.
Entry point for OBO-enabled services.
Service interface exposing OBO-enabled endpoints to get user session information.
Service interface exposing OBO-enabled endpoints to manage signals information.
Service interface exposing OBO-enabled endpoints to manage streams.
Service interface exposing OBO-enabled endpoints to manage users.
Functional Interface to accommodate for API endpoints with pagination.
Retrieve a list of elements given a OffsetBasedPaginatedApi.
The implementation of DatafeedIdRepository interface for persisting a datafeed id on disk.
 
Pagination
Pagination Attribute model to be used in default pagination methods provided by bdk services class.
PaginationCursors
Password.
PasswordReset
Gets or Sets type
Experimental implementation of the default CommandActivity that ease parsing of the text message.
 
Application Entitlements for the company
PodCertificate
Information Barrier Policy record.
Gets or Sets policyType
Presence
Gets or Sets category
 
Service class for managing user presence information.
The list of all possible values for the presence status.
Helper class for parsing the PresentationML to text content.
Exception thrown when the PresentationMLParser failed to parse a PresentationML string.
Application Product
Protocol
The LoadBalancingStrategy corresponding to the BdkLoadBalancingMode.RANDOM mode.
Interface definition for a callback to be invoked when a real-time event is received from the datafeed.
Utility class used to attach a method call (defined by a BiConsumer) to a specific real-time event.
Class used by RetryWithRecovery to store a recovery strategy, i.e.
CommandToken which matches a word in a V4Message if it mathces a given regex.
Internal exception to convey the message that ack id should not be updated thus re-queuing events.
This class aims to implement a retry mechanism (on top of aRetry) with different recovery strategies based on predicates.
Abstract class to implement a retry mechanism with recovery strategies, e.g.
Builder class to facilitate the instantiation of a RetryWithRecovery.
Role record.
Role detailed.
Static roles that have special logic attached to them.
RoomAttributes
Room Creation Object.
Generated when a room is created.
RoomCreatedMessageAllOf
Generated when a room is deactivated.
RoomDeactivatedMessageAllOf
RoomDetail
Generated when a room member is promoted to owner.
RoomMemberDemotedFromOwnerMessageAllOf
Generated when a room member is promoted to owner.
RoomMemberPromotedToOwnerMessageAllOf
 
Generated when a room is reactivated.
RoomReactivatedMessageAllOf
Room Query Object.
Sort algorithm to be used.
A list of search results and counts per search parameter.
RoomSpecificStreamAttributes
RoomSystemInfo
Room Tag object.
Generated when a room is updated.
RoomUpdatedMessageAllOf
The LoadBalancingStrategy corresponding to the BdkLoadBalancingMode.ROUND_ROBIN mode.
 
 
 
Information about the current user's session
Service class for exposing endpoints to get user session information.
 
ShareArticle
ShareContent
Signal
SignalAllOf
 
Service class for managing signal information.
A string wrapped in a JSON object.
A "slash" command if the most basic action that can be performed by an end-user through the chat.
Class representing the pattern of a SlashCommand.
This exception is triggered when a SlashCommand is instantiated with an invalid command pattern.
Sorting direction for response.
Command token only matching a given fixed word.
Stream
File attachments for a message in a stream
StreamAttributes
Stream filtering parameters.
Stream Pagination Attribute model to be used in stream pagination methods provided by bdk services class.
 
Service class for managing streams.
StreamType
Gets or Sets type
Deprecated.
Use IdUtil instead.
A command token matching a single word and put in a given argument.
StringId
SuccessResponse
Gets or Sets format
Functional interface which supplies a T object and may throw an ApiException.
BDK entry point.
Fluent builder for advanced configuration of the SymphonyBdk entry point.
 
Token
Command token matching a specific type and put in a given argument.
User record.
 
Application Entitlements for the user
Application Entitlements to patch for the user
If \"TRUE\", this application will be installed for this user.
If \"TRUE\", this application will be listed in the appstore for this user.
UserAppEntitlementPatchEnum
UserAppEntitlementPatchEnum type : * TRUE - The parameter should be set to true.
User record.
Gets or Sets accountType
Class to represent the claim "user" in the jwt used in extension app authentication.
Basic user information to include in other models
Connection status between two users
Connection status between the requesting user and the request sender
Request body for the Connection APIs
User Creation Object.
User object response
Detailed User record.
 
User error information
The list of available user features.
UserFilter
Gets or Sets status
User group assignee object
response
Body for user group assignee update
User Group assignment response object
Body for group creation
Group object response
Body for user group membership response
Body for user group membership creation
UserGroupMembershipResponse
User object response
User Group membership update object
Group object response
UserGroupResponseList
Body for group update
UserId
Used to extract the tenant ID from a user ID.
User record.
A user-joined-room activity corresponds to an User joined room event.
Default implementation of the ActivityContext handled by the UserJoinedRoomActivity.
Generated when a user joins a room.
UserJoinedRoomMessageAllOf
Generated when a user leaves a room.
UserLeftRoomMessageAllOf
UserName
 
UserSearchFilter
UserSearchQuery
UserSearchResults
Service class for managing users.
UserStatus
Gets or Sets status
UserSuspension
User Status Information.
Gets or Sets status
User record version 2
Gets or Sets accountType
 
V1AuditTrailInitiatorList
Audit Trail Initiator object response.
A representation of content type of message sent by a user of Symphony (message/stream/signal)
Dictionary object
Content of a dictionary
Dictionary's metadata (excluding content)
List of dictionary metadata.
Dictionary's metadata (excluding content) to use for dictionary create operations.
Dictionary response containing dictionary metadata.
Dictionary's metadata (excluding content) to use for dictionary update operations.
Basic information needed to identify a dictionary
A representation of policy that matched the violation with a list of matched keywords in the policy
A representation of outcome of DLP message/stream/signal sent by a user of Symphony
List of policies
The policy object for expression filter, one policy can have multiple dictionaries
The policy object to use for creating/updating a policy.
Policy Response
Signal details
Room details in the context of violation.
A representation of a violation due to a message sent by a user of Symphony
V1DLPViolationMessage
V1DLPViolationMessageResponse
V1DLPViolationSignal
V1DLPViolationSignalResponse
V1DLPViolationStream
V1DLPViolationStreamResponse
V1HealthCheckResponse
V1IMAttributes
V1IMDetail
additional optional properties for the stream
stream filter criteria
Stream information
list of streams info
V2AdminStreamType
V2BaseMessage
V2ConversationSpecificStreamAttributes
V2Error
V2HealthCheckResponse
A historic message to be imported into the system.
Gets or Sets format
V2ImportResponse
Detailed membership record.
List of members in the stream.
User detail information for stream membership
A representation of a message sent by a user of Symphony.
V2MessageAllOf
V2MessageSubmission
Gets or Sets format
V2Presence
V2PresenceAllOf
V2PresenceStatus
V2RoomAttributes
V2RoomDetail
Room Query Object.
Sort algorithm to be used.
V2RoomSearchCriteriaAllOf
V2RoomSpecificStreamAttributes
V2StreamAttributes
V2StreamType
V2 User record.
Gets or Sets accountType
V2 User Creation Object.
V2 Detailed User record.
User RSA key information.
List of User record version 2
V2UserPresence
V2UserPresenceAllOf
Identity of a dictionary.
V3DLPFileClassifierConfig
Extension detection config for allowed and blocked types of file extensions.
Password protected detection config for files that are password protected or not.
File size config defines maximum allowed size of file.
List of policies.
A policy is the main entity of V3 policy/rule system.
V3DLPPolicyAppliesTo
Request to be used to get policies.
Policy Response.
A Rule defines the actual matching specification for policies.
This is a configuration that can be used to match text or regex.
A representation of a violation due to an event created by a user of Symphony
V3DLPViolationMessage
V3DLPViolationMessageResponse
V3DLPViolationSignal
V3DLPViolationSignalResponse
V3DLPViolationStream
V3DLPViolationStreamResponse
V3Health
Type of authentication
V3HealthComponent
Application health status.
V3RoomAttributes
V3RoomDetail
A list of search results and counts per search parameter.
V4AttachmentInfo
V4ConnectionAccepted
V4ConnectionRequested
V4Event
A historic message to be imported into the system.
V4ImportedMessageAttachment
V4ImportResponse
V4Initiator
V4InstantMessageCreated
V4KeyValuePair
A representation of a message sent by a user of Symphony
Wrapper response for a single message sent to multiple streams
V4MessageSent
V4MessageSuppressed
V4Payload
V4RoomCreated
V4RoomDeactivated
V4RoomMemberDemotedFromOwner
V4RoomMemberPromotedToOwner
V4RoomProperties
V4RoomReactivated
V4RoomUpdated
V4SharedPost
V4Stream
V4SymphonyElementsAction
V4ThumbnailInfo
V4User
V4UserJoinedRoom
V4UserLeftRoom
V4UserRequestedToJoinRoom
Container for the feed ID
V5DatafeedCreateBody
V5EventList
V5EventsReadBody