Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Verint Community 11.x
  • Verint Community
Verint Community 11.x
API Documentation IClientsController Plugin Supplementary Type
  • User Documentation
  • Ask the Community
  • API Documentation
  • Manager Training
  • Developer Training
  • Tags
  • More
  • Cancel
  • New
  • API Documentation
  • +In-Process API Documentation
  • -Plugin API Documentation
    • -Plugin Associated Types
      • ActivityStoryActor Plugin Supplementary Type
      • ActivityStoryCreateOptions Plugin Supplementary Type
      • ActivityStoryUpdateOptions Plugin Supplementary Type
      • ApiList(T) Plugin Supplementary Type
      • Application Plugin Supplementary Type
      • AuthenticationOptions (v2) Plugin Supplementary Type
      • AutomationEventHandler Plugin Supplementary Type
      • AutomationEventOptions Plugin Supplementary Type
      • AutomationVersioningResult Plugin Supplementary Type
      • BeforeInitializationArguments Plugin Supplementary Type
      • BusMessageReceivedEventArgs Plugin Supplementary Type
      • BusMessageSource Plugin Supplementary Type
      • Color Plugin Supplementary Type
      • Container Plugin Supplementary Type
      • Content Plugin Supplementary Type
      • ContextItem Plugin Supplementary Type
      • DateRangeFacet (v2) Plugin Supplementary Type
      • DateRangeFacetResult Plugin Supplementary Type
      • DateRangeFilter (v2) Plugin Supplementary Type
      • EditableReviewableContentData Plugin Supplementary Type
      • EmailTarget Plugin Supplementary Type
      • EmbeddableContentFragmentValidationState (v2) Plugin Supplementary Type
      • Error Plugin Supplementary Type
      • ExtendedAttribute Plugin Supplementary Type
      • FieldFacet (v2) Plugin Supplementary Type
      • FieldFacetResult Plugin Supplementary Type
      • FieldFacetSort (v2) Plugin Supplementary Type
      • FieldFilter (v2) Plugin Supplementary Type
      • FileViewerMediaType Plugin Supplementary Type
      • FileViewerViewType Plugin Supplementary Type
      • Group Plugin Supplementary Type
      • HttpMethod (v2) Plugin Supplementary Type
      • IAbuseController Plugin Supplementary Type
      • IActivityStory Plugin Supplementary Type
      • IActivityStoryController Plugin Supplementary Type
      • IActivityStoryUpdateController Plugin Supplementary Type
      • IAdministrationExplicitPanelController Plugin Supplementary Type
      • IApiController Plugin Supplementary Type
      • IApplication Plugin Supplementary Type
      • IApplicationStateChanges Plugin Supplementary Type
      • IAutomationEventController Plugin Supplementary Type
      • IAutomationFactoryDefaultController Plugin Supplementary Type
      • ICentralizedFile Plugin Supplementary Type
      • ICentralizedFileEventExecutor Plugin Supplementary Type
      • ICentralizedFileStorageProvider Plugin Supplementary Type
      • IClientsController Plugin Supplementary Type
      • IContainer Plugin Supplementary Type
      • IContainerStateChanges Plugin Supplementary Type
      • IContent Plugin Supplementary Type
      • IContentEmbeddableContentTypeController Plugin Supplementary Type
      • IContentFragmentConfigurationAdjustmentController Plugin Supplementary Type
      • IContentReviewController Plugin Supplementary Type
      • IContentStateChanges Plugin Supplementary Type
      • IContextualScriptedContentFragmentExtension Plugin Supplementary Type
      • ICustomNavigationItem (v2) Plugin Supplementary Type
      • ICustomNavigationItemConfiguration (v2) Plugin Supplementary Type
      • IEmbeddableContentFragment (v2) Plugin Supplementary Type
      • IEmbeddableContentFragment Plugin Supplementary Type
      • IExplicitPanelController Plugin Supplementary Type
      • IExportUserDataSourceController Plugin Supplementary Type
      • IExtendedAttribute Plugin Supplementary Type
      • IFileEmbeddableContentTypeController Plugin Supplementary Type
      • IFileViewerOptions Plugin Supplementary Type
      • IGroupNewPostLink Plugin Supplementary Type
      • IHashTagController Plugin Supplementary Type
      • IHttpCallbackController Plugin Supplementary Type
      • IHttpRequest Plugin Supplementary Type
      • IInstallableCfsFile Plugin Supplementary Type
      • ILanguageDetectionController Plugin Supplementary Type
      • IMentionableFilter Plugin Supplementary Type
      • IMentionController Plugin Supplementary Type
      • IMessageBusController Plugin Supplementary Type
      • IMetricController Plugin Supplementary Type
      • IMigratableCentralizedFileStorageProviderController Plugin Supplementary Type
      • IndexField Plugin Supplementary Type
      • INotificationController Plugin Supplementary Type
      • IPageOutputController Plugin Supplementary Type
      • IPermission Plugin Supplementary Type
      • IPermissionRegistrarController Plugin Supplementary Type
      • IPluginConfiguration (v2) Plugin Supplementary Type
      • IPropertyRuleExecutionOptions Plugin Supplementary Type
      • IPropertyRuleRenderingOptions Plugin Supplementary Type
      • IPropertyTemplateOptions Plugin Supplementary Type
      • IReadOnlyConfigurationData Plugin Supplementary Type
      • IRestEndpointController (v2) Plugin Supplementary Type
      • IRestRequest (v2) Plugin Supplementary Type
      • IRestResponse (v2) Plugin Supplementary Type
      • IScoreController Plugin Supplementary Type
      • IScriptedContentFragmentController Plugin Supplementary Type
      • ISocketController Plugin Supplementary Type
      • ITemplatablePluginController Plugin Supplementary Type
      • ITokenizedTemplateDataTypeContainerToken Plugin Supplementary Type
      • ITokenizedTemplateEnumerableToken Plugin Supplementary Type
      • ITokenizedTemplateImageUrlToken Plugin Supplementary Type
      • ITokenizedTemplateLinkUrlToken Plugin Supplementary Type
      • ITokenizedTemplatePrimitiveToken Plugin Supplementary Type
      • ITokenizedTemplateToken Plugin Supplementary Type
      • ITokenizedTemplateTokenController Plugin Supplementary Type
      • ITranslatablePluginAdjustmentController Plugin Supplementary Type
      • ITranslatablePluginController Plugin Supplementary Type
      • IUrlAccessController Plugin Supplementary Type
      • IUrlController Plugin Supplementary Type
      • IUserActionLink Plugin Supplementary Type
      • IWebContext Plugin Supplementary Type
      • IWebhookController Plugin Supplementary Type
      • IWebhookEvent Plugin Supplementary Type
      • IWeightedMetric Plugin Supplementary Type
      • JobData Plugin Supplementary Type
      • JoinlessGroupPermissionConfiguration Plugin Supplementary Type
      • ListReviewableContentOptions Plugin Supplementary Type
      • MembershipGroupPermissionConfiguration Plugin Supplementary Type
      • MessageReceivedEventArgs Plugin Supplementary Type
      • Notification Plugin Supplementary Type
      • NotificationActor Plugin Supplementary Type
      • NotificationCategory Plugin Supplementary Type
      • NotificationCreateUpdateOptions Plugin Supplementary Type
      • NotificationDeleteOptions Plugin Supplementary Type
      • NotificationUserChanges Plugin Supplementary Type
      • OAuthData Plugin Supplementary Type
      • PageContext Plugin Supplementary Type
      • PageDefinitionOptions Plugin Supplementary Type
      • PagedList(T) Plugin Supplementary Type
      • PathSearchOption Plugin Supplementary Type
      • PermissionConfiguration Plugin Supplementary Type
      • PluginInitializationReason Plugin Supplementary Type
      • PrimitiveType Plugin Supplementary Type
      • ProfileField Plugin Supplementary Type
      • Property Plugin Supplementary Type
      • PropertyGroup Plugin Supplementary Type
      • PropertyRule Plugin Supplementary Type
      • PropertyRuleOption Plugin Supplementary Type
      • PropertySubGroup Plugin Supplementary Type
      • PropertyTemplateOption Plugin Supplementary Type
      • PropertyValue Plugin Supplementary Type
      • RawDefinitionOptions Plugin Supplementary Type
      • ReadOnlyReviewableContentActionData Plugin Supplementary Type
      • ReadOnlyReviewableContentData Plugin Supplementary Type
      • RenderTarget Plugin Supplementary Type
      • RestEndpointDocumentation (v2) Plugin Supplementary Type
      • RestEndpointDocumentationAttribute Plugin Supplementary Type
      • RestParameterLocation Plugin Supplementary Type
      • RestRequestDocumentationAttribute Plugin Supplementary Type
      • RestRequired Plugin Supplementary Type
      • RestResponseDocumentationAttribute Plugin Supplementary Type
      • ReviewableContent Plugin Supplementary Type
      • ReviewableContentHistory Plugin Supplementary Type
      • ReviewableContentOptions Plugin Supplementary Type
      • ReviewWorkflow Plugin Supplementary Type
      • ReviewWorkflowConfigurationFormOptions Plugin Supplementary Type
      • Rule Plugin Supplementary Type
      • ScopedProperty Plugin Supplementary Type
      • ScriptedContentFragmentMetadata Plugin Supplementary Type
      • ScriptedContentFragmentOptions Plugin Supplementary Type
      • SearchCategory Plugin Supplementary Type
      • SearchField Plugin Supplementary Type
      • SearchFilterBase (v2) Plugin Supplementary Type
      • SearchIndexDeleteOptions Plugin Supplementary Type
      • SearchIndexDocument Plugin Supplementary Type
      • SearchResult Plugin Supplementary Type
      • SearchResults Plugin Supplementary Type
      • SearchResultsListOptions (v2) Plugin Supplementary Type
      • Target Plugin Supplementary Type
      • TemplateContext Plugin Supplementary Type
      • TokenizedTemplate Plugin Supplementary Type
      • Translation Plugin Supplementary Type
      • Unit Plugin Supplementary Type
      • User Plugin Supplementary Type
      • UserConnectedEventArgs Plugin Supplementary Type
      • UserDisconnectedEventArgs Plugin Supplementary Type
      • Warning Plugin Supplementary Type
    • +Plugin Types
  • +REST API Documentation
  • +Widget, Theme, and Automation APIs

IClientsController Plugin Supplementary Type


Controller for receiving and sending messages to clients

IClientsController is defined in the Telligent.Evolution.Extensibility.Sockets.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

interface IClientsController
{
	event EventHandler<UserConnectedEventArgs> Connected { add; remove; }
	event EventHandler<UserDisconnectedEventArgs> Disconnected { add; remove; }
	event EventHandler<MessageReceivedEventArgs> Received { add; remove; }
	void Broadcast(string messageName, Object data = null);
	Task BroadcastAsync(string messageName, Object data = null, CancellationToken cancellationToken = null);
	void Send(int userId, string messageName, Object data = null);
	Task SendAsync(int userId, string messageName, Object data = null, CancellationToken cancellationToken = null);
	void SendToUsersPresentToContent(Guid contentId, string messageName, Object data = null, Guid? presenceTypeId = null);
	void SendToUsersPresentToContent(string contentUrl, Guid oauthClientId, string messageName, Object data = null, Guid? presenceTypeId = null);
	Task SendToUsersPresentToContentAsync(Guid contentId, string messageName, Object data = null, Guid? presenceTypeId = null, CancellationToken cancellationToken = null);
	Task SendToUsersPresentToContentAsync(string contentUrl, Guid oauthClientId, string messageName, Object data = null, Guid? presenceTypeId = null, CancellationToken cancellationToken = null);
	void SendToUsersPresentToService(Guid serviceId, string messageName, Object data = null, Guid? presenceTypeId = null);
	Task SendToUsersPresentToServiceAsync(Guid serviceId, string messageName, Object data = null, Guid? presenceTypeId = null, CancellationToken cancellationToken = null);
}

Events

Connected

Event raised when a user connects or reconnects after an interruption

Handler

void EventHandler<UserConnectedEventArgs>(Object sender, UserConnectedEventArgs e);

Disconnected

Event raised when a user disconnects

Handler

void EventHandler<UserDisconnectedEventArgs>(Object sender, UserDisconnectedEventArgs e);

Received

Event raised when a message is received from a user

Handler

void EventHandler<MessageReceivedEventArgs>(Object sender, MessageReceivedEventArgs e);

Methods

void Broadcast(string messageName, Object data = null);

Sends a message to all users, along with optional message data to serialize as JSON

Parameters

NameTypeDescriptionRequiredDefaultOptions
messageNamestringMessage NameRequired
dataObjectDataOptional

Task BroadcastAsync(string messageName, Object data = null, CancellationToken cancellationToken = null);

Sends a message to all users, along with optional message data to serialize as JSON

Parameters

NameTypeDescriptionRequiredDefaultOptions
messageNamestringMessage NameRequired
dataObjectDataOptional
cancellationTokenCancellationTokenCancellation TokenOptional

Return Type

Task

void Send(int userId, string messageName, Object data = null);

Sends a message to a specific user, along with optional message data to serialize as JSON

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdintUser IdRequired
messageNamestringMessage NameRequired
dataObjectDataOptional

Task SendAsync(int userId, string messageName, Object data = null, CancellationToken cancellationToken = null);

Sends a message to a specific user, along with optional message data to serialize as JSON

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdintUser IdRequired
messageNamestringMessage NameRequired
dataObjectDataOptional
cancellationTokenCancellationTokenCancellation TokenOptional

Return Type

Task

void SendToUsersPresentToContent(Guid contentId, string messageName, Object data = null, Guid? presenceTypeId = null);

Sends a message to users present to a specific piece of content, along with optional message data to serialize as JSON

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
messageNamestringMessage NameRequired
dataObjectDataOptional
presenceTypeIdGuid?Presence Type IdOptional

void SendToUsersPresentToContent(string contentUrl, Guid oauthClientId, string messageName, Object data = null, Guid? presenceTypeId = null);

Sends a message to users present to a specific piece of content, along with optional message data to serialize as JSON

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlstringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
messageNamestringMessage NameRequired
dataObjectDataOptional
presenceTypeIdGuid?Presence Type IdOptional

Task SendToUsersPresentToContentAsync(Guid contentId, string messageName, Object data = null, Guid? presenceTypeId = null, CancellationToken cancellationToken = null);

Sends a message to users present to a specific piece of content, along with optional message data to serialize as JSON

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
messageNamestringMessage NameRequired
dataObjectDataOptional
presenceTypeIdGuid?Presence Type IdOptional
cancellationTokenCancellationTokenCancellation TokenOptional

Return Type

Task

Task SendToUsersPresentToContentAsync(string contentUrl, Guid oauthClientId, string messageName, Object data = null, Guid? presenceTypeId = null, CancellationToken cancellationToken = null);

Sends a message to users present to a specific piece of content, along with optional message data to serialize as JSON

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentUrlstringContent UrlRequired
oauthClientIdGuidOauth Client IdRequired
messageNamestringMessage NameRequired
dataObjectDataOptional
presenceTypeIdGuid?Presence Type IdOptional
cancellationTokenCancellationTokenCancellation TokenOptional

Return Type

Task

void SendToUsersPresentToService(Guid serviceId, string messageName, Object data = null, Guid? presenceTypeId = null);

Sends a message to users present to a specific service, along with optional message data to serialize as JSON

Parameters

NameTypeDescriptionRequiredDefaultOptions
serviceIdGuidService IdRequired
messageNamestringMessage NameRequired
dataObjectDataOptional
presenceTypeIdGuid?Presence Type IdOptional

Task SendToUsersPresentToServiceAsync(Guid serviceId, string messageName, Object data = null, Guid? presenceTypeId = null, CancellationToken cancellationToken = null);

Sends a message to users present to a specific service, along with optional message data to serialize as JSON

Parameters

NameTypeDescriptionRequiredDefaultOptions
serviceIdGuidService IdRequired
messageNamestringMessage NameRequired
dataObjectDataOptional
presenceTypeIdGuid?Presence Type IdOptional
cancellationTokenCancellationTokenCancellation TokenOptional

Return Type

Task


  • Share
  • History
  • More
  • Cancel
Related
Recommended
  • Telligent
  • Professional Services
  • Submit a Support Ticket
  • Become a Partner
  • Request a Demo
  • Contact Us

About
Privacy Policy
Terms of use
Copyright 2024 Verint, Inc.
Powered by Verint Community