Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Verint Community 13.x
  • Verint Community
Verint Community 13.x
API Documentation INotificationType Plugin 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
    • -Plugin Types
      • CommunityException Provider Type
      • IAbuseCheckingContentType Plugin Type
      • IAbuseDetector Plugin Type
      • IActivityStoryContentType Plugin Type
      • IActivityStoryEmbeddableContentFragmentType (v2) Plugin Type
      • IActivityStoryType Plugin Type
      • IActivityStoryUpdateIdentifier Plugin Type
      • IAdministrationExplicitPanel Plugin Type
      • IAdministrationPanel Plugin Type
      • IAdministrationPanelCategory Plugin Type
      • IApi Provider Type
      • IApiDefinition Plugin Type
      • IApplicationMerger (v2) Plugin Type
      • IApplicationNavigable Plugin Type
      • IApplicationPanel Plugin Type
      • IApplicationSecuredFilterableContentType Plugin Type
      • IApplicationType Plugin Type
      • IAuthenticationPlugin (v3) Plugin Type
      • IAutomationEventDefinition Plugin Type
      • IAutomationFactoryDefaultProvider Plugin Type
      • IBadgeableAdministrationExplicitPanel Plugin Type
      • IBadgeableAdministrationPanel Plugin Type
      • IBadgeableApplicationPanel Plugin Type
      • IBadgeableContainerPanel Plugin Type
      • IBadgeableExplicitPanel Plugin Type
      • IBadgeableThemePanel Plugin Type
      • IBeforeInitializationPlugin Plugin Type
      • IBookmarkableContentType Plugin Type
      • ICategorizedMentionContainingContentType Plugin Type
      • ICategorizedPlugin Plugin Type
      • ICentralizedFileStorageProvider Provider Type
      • ICentralizedFileStore Plugin Type
      • IChildSecuredContentType Plugin Type
      • ICommentableContentType Plugin Type
      • IConfigurablePlugin (v2) Plugin Type
      • IConfigurableThemeableApplicationType Plugin Type
      • IContainerPanel Plugin Type
      • IContainerType Plugin Type
      • IContentConverter (v3) Plugin Type
      • IContentEmbeddableContentType (v2) Plugin Type
      • IContentFragmentConfigurationAdjustment Plugin Type
      • IContentFragmentImportAdjustment Plugin Type
      • IContentFragmentScopedPropertyAdjustment Plugin Type
      • IContentSpecificHtmlEventsExecutor Plugin Type
      • IContentType Plugin Type
      • IContentTypeLimitedMetric Plugin Type
      • IContentTypeLimitedScore Plugin Type
      • IContextualMentionContainingContentType Plugin Type
      • ICustomNavigationPlugin (v3) Plugin Type
      • ICustomPageSupportingThemeableApplicationType Plugin Type
      • ICustomUrlContentConverter (v3) Plugin Type
      • IDefaultWeightedScore Plugin Type
      • IDelayableNotificationType Plugin Type
      • IDisablableDecayScore Plugin Type
      • IDisabledContentNotificationType Plugin Type
      • IDistributedCacheProvider Plugin Type
      • IDownloadEventEnabledCentralizedFileStorageProvider Provider Type
      • IEmailAttachmentNotificationType (v2) Plugin Type
      • IEmailFromNotificationType Plugin Type
      • IEmailHandler (v2) Plugin Type
      • IEmailHeaderNotificationType Plugin Type
      • IEmailNotificationType Plugin Type
      • IEmailProvider Plugin Type
      • IEmailRetrievalProvider (v2) Plugin Type
      • IEmbeddableAdjustment (v2) Plugin Type
      • IEmbeddableContentFragmentType (v2) Plugin Type
      • IEmbeddedFileManagingPropertyTemplate Plugin Type
      • IEmbeddedThemeableApplicationType Plugin Type
      • IEventEnabledCentralizedFileStorageProvider Provider Type
      • IEvolutionJob Provider Type
      • IExceptionCategory Plugin Type
      • IExplicitPanel Plugin Type
      • IExportableUserDataSource Plugin Type
      • IExtension Plugin Type
      • IExternalLinkedAuthenticationProvider (v2) Plugin Type
      • IFeaturableContentType Plugin Type
      • IFileEmbeddableContentType Plugin Type
      • IFileViewer Plugin Type
      • IFilteredPluginTypesAdministrationPanel Plugin Type
      • IFindableCentralizedFileStore Plugin Type
      • IGloballySecuredCentralizedFileStore Plugin Type
      • IGroupCustomNavigationPlugin (v3) Plugin Type
      • IGroupDefaultCustomNavigationPlugin (v3) Plugin Type
      • IGroupNewPostLinkPlugin Plugin Type
      • IHashTaggableContentType Plugin Type
      • IHtmlHeaderExtension Plugin Type
      • IHttpAsyncCallback Plugin Type
      • IHttpAsyncRenderableCentralizedFileStorageProvider Provider Type
      • IHttpCallback Plugin Type
      • IHttpRenderableCentralizedFileStorageProvider Provider Type
      • IHttpRequestFilter Plugin Type
      • IIndexedMentionableContentType (v2) Plugin Type
      • IInstallablePlugin Plugin Type
      • ILanguageDetector Plugin Type
      • ILegacyTemplatableEmail Plugin Type
      • ILikeableContentType Plugin Type
      • IMaintainedSearchableContentType Plugin Type
      • IManageableApplicationType (v2) Plugin Type
      • IManageableCommentableContentType Plugin Type
      • IMentionableContentType (v2) Plugin Type
      • IMentionContainingContentType Plugin Type
      • IMessageBus (v2) Plugin Type
      • IMetric Plugin Type
      • IMigratableCentralizedFileStorageProvider Provider Type
      • INavigable Plugin Type
      • INavigableApplicationType Plugin Type
      • INestableContainerType Plugin Type
      • INotificationDistributionType Plugin Type
      • INotificationType Plugin Type
      • IPeekableContentType Plugin Type
      • IPermissionRegistrar Plugin Type
      • IPersistentUrlGeneratingFileStorageProvider Provider Type
      • IPlugin Plugin Type
      • IPluginGroup Plugin Type
      • IPluginTypesAdministrationPanel Plugin Type
      • IPluginTypesEditor Plugin Type
      • IPreviewableAbuseCheckingContentType Plugin Type
      • IPreviewableContentType Plugin Type
      • IPreviewableReviewableContentType Plugin Type
      • IPropertyRule Plugin Type
      • IPropertyRuleAdjustment Plugin Type
      • IPropertyTemplate Plugin Type
      • IPropertyTemplateAdjustment Plugin Type
      • IQueryableApplicationType Plugin Type
      • IRateableContentType Plugin Type
      • IRecurringEvolutionJobPlugin Plugin Type
      • IReindexableSearchableContentType Plugin Type
      • IRenderableConfigurablePlugin (v2) Plugin Type
      • IRequireCleanupAbuseCheckingContentType Plugin Type
      • IRequiredConfigurationPlugin (v2) Plugin Type
      • IRestEndpoints (v2) Plugin Type
      • IRestorableManageableApplicationType (v2) Plugin Type
      • IRestScopeGroups (v2) Plugin Type
      • IReviewableContentType Plugin Type
      • IRuledConfigurablePlugin (v2) Plugin Type
      • IRuledEmbeddableContentFragmentType (v2) Plugin Type
      • IRuledReviewableContentType Plugin Type
      • IScopeSupportingThemeableApplicationType Plugin Type
      • IScore Plugin Type
      • IScriptablePlugin Plugin Type
      • IScriptedContentFragmentContextProvider (v2) Plugin Type
      • IScriptedContentFragmentExtension Plugin Type
      • IScriptedContentFragmentFactoryDefaultProvider Plugin Type
      • IScriptedEmail Plugin Type
      • IScriptedEmbeddableFactoryDefaultProvider (v2) Plugin Type
      • ISearchableContentType Plugin Type
      • ISearchAttachmentTextExtractor Plugin Type
      • ISearchCategories Plugin Type
      • ISearchProvider Plugin Type
      • ISecuredAbuseReviewContentType Plugin Type
      • ISecuredApplicationMerger (v2) Plugin Type
      • ISecuredBookmarkViewContentType Plugin Type
      • ISecuredCentralizedFileStore Plugin Type
      • ISecuredCommentViewContentType Plugin Type
      • ISecuredContentConverter (v3) Plugin Type
      • ISecuredContentType Plugin Type
      • ISecuredLikeViewContentType Plugin Type
      • ISecuredMentionViewContentType Plugin Type
      • ISecuredRatingViewContentType Plugin Type
      • ISecuredSubscriptionViewContentType Plugin Type
      • ISecuredViewActivityStoryType Plugin Type
      • ISingletonPlugin Plugin Type
      • ISiteCustomNavigationPlugin (v3) Plugin Type
      • ISocket Plugin Type
      • ISubscribableContentType Plugin Type
      • ISubscriptionViewContentType Plugin Type
      • ISystemStatusIndicator Plugin Type
      • ITagBrowseableApplicationType Plugin Type
      • ITagBrowseableContainerType Plugin Type
      • ITaggableContentType Plugin Type
      • ITagModeratingApplicationType Plugin Type
      • ITemplatableConfigurablePlugin (v2) Plugin Type
      • ITemplatableCustomNavigationPlugin (v3) Plugin Type
      • ITemplatableEmbeddableContentFragmentType (v2) Plugin Type
      • ITemplatableReviewableContentType Plugin Type
      • IThemeableApplicationType Plugin Type
      • IThemePanel Plugin Type
      • ITranslatablePlugin Plugin Type
      • ITranslatablePluginAdjustment Plugin Type
      • IUserActionLinkPlugin Plugin Type
      • IUserCustomNavigationPlugin (v3) Plugin Type
      • IUserDefaultCustomNavigationPlugin (v3) Plugin Type
      • IUserInterfaceRestApiAccessingPlugin Plugin Type
      • IUserRenderableException Provider Type
      • IUserRenderableMessage Plugin Type
      • IVersionedCentralizedFileStorageProvider Provider Type
      • IViewableContentType Plugin Type
      • IWebContextualApplicationType Plugin Type
      • IWebContextualContainerType Plugin Type
      • IWebContextualContentType Plugin Type
      • IWebhookRegistrar Plugin Type
  • +REST API Documentation
  • +Widget, Theme, and Automation APIs

INotificationType Plugin Type


The base interface allowing content, applications, and containers to interact with notifications. Each type has a sub interface that also defines how to get the item.

INotificationType is defined in the Telligent.Evolution.Extensibility.Content.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

interface INotificationType : IPlugin
{
	bool IsCacheable { get;  }
	string NotificationTypeCategory { get;  }
	string NotificationTypeDescription { get;  }
	Guid NotificationTypeId { get;  }
	string NotificationTypeName { get;  }
	bool VaryCacheByUser { get;  }
	bool CanDeleteNotification(Guid notificationId, int userId);
	string GetMessage(Guid notificationId, string target);
	string GetTargetUrl(Guid notificationId);
	void SetController(INotificationController controller);
}

Properties

NameTypeDescriptionDefaultOptions
IsCacheableboolA flag to allow caching of the output of GetMessage().
NotificationTypeCategorystringThe category to group the notification type into.
NotificationTypeDescriptionstringA description of the notification type.
NotificationTypeIdGuidA Guid uniquely identifying the notification type.
NotificationTypeNamestringA readable name for the type of notification created for this item. For example, blog posts use “Blog Post Notification”.
VaryCacheByUserboolA flag to cache on a per user basis, particularly useful for security reasons.

Methods

bool CanDeleteNotification(Guid notificationId, int userId);

Used to check whether a user can delete a notification.

Parameters

NameTypeDescriptionRequiredDefaultOptions
notificationIdGuidNotification IdRequired
userIdintUser IdRequired

Return Type

bool

string GetMessage(Guid notificationId, string target);

Returns the view of the notification for a given target (Html, Text, ShortText).

Parameters

NameTypeDescriptionRequiredDefaultOptions
notificationIdGuidNotification IdRequired
targetstringTargetRequiredHtml, ShortText, Text

Return Type

string

string GetTargetUrl(Guid notificationId);

Returns a target URL related to the notification

Parameters

NameTypeDescriptionRequiredDefaultOptions
notificationIdGuidNotification IdRequired

Return Type

string

void SetController(INotificationController controller);

This method is called each time the plugin is loaded. The controller gives privileged access to the plugin not available via the API. Whenever content is created, updated, or deleted, the controller should be used to notify Telligent Evolution of the event so the notification service can perform any necessary updates.

Parameters

NameTypeDescriptionRequiredDefaultOptions
controllerINotificationControllerControllerRequired

Extensions

  • IDelayableNotificationType
  • IDisabledContentNotificationType
  • IEmailAttachmentNotificationType
  • IEmailAttachmentNotificationType
  • IEmailFromNotificationType
  • IEmailHeaderNotificationType
  • IEmailNotificationType

  • 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