﻿<?xml version="1.0" encoding="utf-8"?>
<doc>
  <assembly>
    <name>DevExpress.ExpressApp.Notifications.v23.1</name>
  </assembly>
  <members>
    <member name="N:DevExpress.ExpressApp.Notifications">
      <summary>
        <para>Contains base classes and services of the <see href="https://docs.devexpress.com/eXpressAppFramework/113688/event-planning-and-notifications/notifications-module">Notifications Module</see>.</para>
      </summary>
    </member>
    <member name="T:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider">
      <summary>
        <para>A <see href="https://docs.devexpress.com/eXpressAppFramework/113693/event-planning-and-notifications/notifications/notifications-service-and-notifications-providers">Notifications Provider</see> that collects notifications from business objects that support the <see cref="T:DevExpress.Persistent.Base.General.ISupportNotifications"/> interface. Types that have descendants are ignored to avoid duplicate notifications.</para>
      </summary>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider.#ctor(DevExpress.ExpressApp.XafApplication)">
      <summary>
        <para>Initializes a new instance of the <see cref="T:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider"/> class.</para>
      </summary>
      <param name="application">An <see cref="T:DevExpress.ExpressApp.XafApplication"/> object that manages an XAF application.</param>
    </member>
    <member name="E:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider.CustomizeNotificationCollectionCriteria">
      <summary>
        <para>Occurs before a criteria is applied to the notifications collection.</para>
      </summary>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider.Dismiss(System.Collections.Generic.IEnumerable{DevExpress.Persistent.Base.General.INotificationItem})">
      <summary>
        <para>Dismisses the specified notification item.</para>
      </summary>
      <param name="notificationItems">An <see cref="T:DevExpress.Persistent.Base.General.INotificationItem"/> object to be dismissed.</param>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider.Dispose">
      <summary>
        <para>Releases all resources used by an <see cref="T:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider"/> object.</para>
      </summary>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider.GetActiveNotificationsCount">
      <summary>
        <para>Returns the number of active notifications.</para>
      </summary>
      <returns>An integer value which is the number of active notifications.</returns>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider.GetNotificationItems">
      <summary>
        <para>Returns the list of notification items.</para>
      </summary>
      <returns>An IEnumerable&lt;<see cref="T:DevExpress.Persistent.Base.General.INotificationItem"/>&gt; list of notification items.</returns>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider.GetPostponedNotificationsCount">
      <summary>
        <para>Returns the number of postponed notifications.</para>
      </summary>
      <returns>An integer value which is the number of postponed notifications.</returns>
    </member>
    <member name="P:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider.NotificationTypesInfo">
      <summary>
        <para>Gets information on business object types supported by the <see cref="T:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider"/> provider.</para>
      </summary>
      <value>A HashSet&lt;ITypeInfo&gt; object that provides information on business object types supported by the DefaultNotificatonProvider provider.</value>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider.Postpone(System.Collections.Generic.IEnumerable{DevExpress.Persistent.Base.General.INotificationItem},System.TimeSpan)">
      <summary>
        <para>Postpones the specified notification item for the given amount of time.</para>
      </summary>
      <param name="notificationItems">A collection of <see cref="T:DevExpress.Persistent.Base.General.INotificationItem"/> notification items to postpone.</param>
      <param name="postponeTime">A <see cref="T:System.TimeSpan"/> object that specifies the amount of time to postpone the notification.</param>
    </member>
    <member name="T:DevExpress.ExpressApp.Notifications.NotificationsController">
      <summary>
        <para>An abstract <see cref="T:DevExpress.ExpressApp.WindowController"/> descendant, that contains the ShowNotificationsAction <see href="https://docs.devexpress.com/eXpressAppFramework/112622/ui-construction/controllers-and-actions/actions">Action</see>.</para>
      </summary>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsController.#ctor">
      <summary>
        <para>Initializes a new instance of the <see cref="T:DevExpress.ExpressApp.Notifications.NotificationsController"/> class.</para>
      </summary>
    </member>
    <member name="E:DevExpress.ExpressApp.Notifications.NotificationsController.CustomizeNotificationViewParameters">
      <summary>
        <para>Occurs before the <see href="https://docs.devexpress.com/eXpressAppFramework/113690/event-planning-and-notifications/notifications/notifications-module-overview">notification</see> window is shown.</para>
      </summary>
    </member>
    <member name="E:DevExpress.ExpressApp.Notifications.NotificationsController.CustomProcessNotifications">
      <summary>
        <para>Occurs before the <see href="https://docs.devexpress.com/eXpressAppFramework/113690/event-planning-and-notifications/notifications/notifications-module-overview">notification</see> window is shown.</para>
      </summary>
    </member>
    <member name="F:DevExpress.ExpressApp.Notifications.NotificationsController.NotificationsActionContainerId">
      <summary>
        <para>Returns the Notification <see href="https://docs.devexpress.com/eXpressAppFramework/112610/ui-construction/action-containers">Action Container</see>‘s ID. The default value is “Notifications”.</para>
      </summary>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsController.RefreshNotifications">
      <summary>
        <para>Refreshes the notification list.</para>
      </summary>
    </member>
    <member name="P:DevExpress.ExpressApp.Notifications.NotificationsController.Service">
      <summary>
        <para>Gets the service used by the <see cref="T:DevExpress.ExpressApp.Notifications.NotificationsModule"/> to process the notifications.</para>
      </summary>
      <value>A <see cref="T:DevExpress.ExpressApp.Notifications.NotificationsService"/> object that is the service used by the NotificationsModule to process the notifications.</value>
    </member>
    <member name="F:DevExpress.ExpressApp.Notifications.NotificationsController.ShowNotificationsAction">
      <summary>
        <para>Specifies the Show Notifications Action that displays the notifications count and invokes the <see href="https://docs.devexpress.com/eXpressAppFramework/113692/event-planning-and-notifications/notifications/reminders-window-elements">Reminders Window</see>.</para>
      </summary>
    </member>
    <member name="T:DevExpress.ExpressApp.Notifications.NotificationsModule">
      <summary>
        <para>The XAF module contained in the DevExpress.ExpressApp.Notifications.v23.1.dll assembly.</para>
      </summary>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsModule.#ctor">
      <summary>
        <para>Initializes a new instance of the <see cref="T:DevExpress.ExpressApp.Notifications.NotificationsModule"/> class.</para>
      </summary>
    </member>
    <member name="P:DevExpress.ExpressApp.Notifications.NotificationsModule.CanAccessPostponedItems">
      <summary>
        <para>Specifies if the ShowNotifications Action remains enabled when there are postponed notifications and no active notifications.</para>
      </summary>
      <value>true, if the ShowNotifications Action remains enabled when there are postponed notifications and no active notifications; otherwise, false.</value>
    </member>
    <member name="P:DevExpress.ExpressApp.Notifications.NotificationsModule.DefaultNotificationsProvider">
      <summary>
        <para>Specifies the default <see href="https://docs.devexpress.com/eXpressAppFramework/113693/event-planning-and-notifications/notifications/notifications-service-and-notifications-providers">Notifications Service and Notifications Providers</see> that collects notifications from <see cref="T:DevExpress.Persistent.Base.General.ISupportNotifications"/> business objects.</para>
      </summary>
      <value>A <see cref="T:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider"/> object that collects notifications from business objects.</value>
    </member>
    <member name="P:DevExpress.ExpressApp.Notifications.NotificationsModule.NotificationsRefreshInterval">
      <summary>
        <para>Specifies the amount of time between successive refreshes of the notifications.</para>
      </summary>
      <value>A <see cref="T:System.TimeSpan"/> value that specifies the amount of time between successive refreshes of the notifications.</value>
    </member>
    <member name="P:DevExpress.ExpressApp.Notifications.NotificationsModule.NotificationsService">
      <summary>
        <para>Gets the <see href="https://docs.devexpress.com/eXpressAppFramework/113693/event-planning-and-notifications/notifications/notifications-service-and-notifications-providers">Notifications Service</see>.</para>
      </summary>
      <value>A <see cref="T:DevExpress.ExpressApp.Notifications.NotificationsService"/> object.</value>
    </member>
    <member name="P:DevExpress.ExpressApp.Notifications.NotificationsModule.NotificationsStartDelay">
      <summary>
        <para>Specifies the delay from the application start to the initial <see href="https://docs.devexpress.com/eXpressAppFramework/113692/event-planning-and-notifications/notifications/reminders-window-elements">Reminders Window</see> display.</para>
      </summary>
      <value>A <see cref="T:System.TimeSpan"/> value that specifies the delay from the application start to the initial <see href="https://docs.devexpress.com/eXpressAppFramework/113692/event-planning-and-notifications/notifications/reminders-window-elements">Reminders Window</see> display. The default is 5 seconds.</value>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsModule.Setup(DevExpress.ExpressApp.XafApplication)">
      <summary>
        <para>Sets up the <see cref="T:DevExpress.ExpressApp.Notifications.NotificationsModule"/> after it has been added to the <see cref="P:DevExpress.ExpressApp.XafApplication.Modules">XafApplication.Modules</see> collection.</para>
      </summary>
      <param name="application">An <see cref="T:DevExpress.ExpressApp.XafApplication"/> object that manages an XAF application.</param>
    </member>
    <member name="P:DevExpress.ExpressApp.Notifications.NotificationsModule.ShowDismissAllAction">
      <summary>
        <para>Specifies whether or not the DismissAll Action is active in the <see href="https://docs.devexpress.com/eXpressAppFramework/113692/event-planning-and-notifications/notifications/reminders-window-elements">Reminders Window</see>.</para>
      </summary>
      <value>true, if the DismissAll Action is active; otherwise, false.</value>
    </member>
    <member name="P:DevExpress.ExpressApp.Notifications.NotificationsModule.ShowNotificationsWindow">
      <summary>
        <para>Specifies if the <see href="https://docs.devexpress.com/eXpressAppFramework/113692/event-planning-and-notifications/notifications/reminders-window-elements">Reminders Window</see> is displayed automatically or a user should invoke it manually.</para>
      </summary>
      <value>true if the window is displayed automatically; otherwise, false. The default is true.</value>
    </member>
    <member name="P:DevExpress.ExpressApp.Notifications.NotificationsModule.ShowRefreshAction">
      <summary>
        <para>Specifies whether or not the Refresh Action is active in the <see href="https://docs.devexpress.com/eXpressAppFramework/113692/event-planning-and-notifications/notifications/reminders-window-elements">Reminders Window</see>.</para>
      </summary>
      <value>true, if the Refresh Action is active; otherwise, false.</value>
    </member>
    <member name="T:DevExpress.ExpressApp.Notifications.NotificationsService">
      <summary>
        <para>A service used by the <see cref="T:DevExpress.ExpressApp.Notifications.NotificationsModule"/> to process the notifications.</para>
      </summary>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.#ctor(DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider)">
      <summary>
        <para>Initializes a new instance of the <see cref="T:DevExpress.ExpressApp.Notifications.NotificationsService"/> class.</para>
      </summary>
      <param name="defaultNotificationsProvider">A <see cref="T:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider"/> object.</param>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.#ctor(DevExpress.ExpressApp.XafApplication,DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider)">
      <summary>
        <para>Initializes a new instance of the <see cref="T:DevExpress.ExpressApp.Notifications.NotificationsService"/> class.</para>
      </summary>
      <param name="application">An <see cref="T:DevExpress.ExpressApp.XafApplication"/> object that manages an XAF application.</param>
      <param name="defaultNotificationsProvider">The <see cref="T:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider"/> object that specifies the <see href="https://docs.devexpress.com/eXpressAppFramework/113693/event-planning-and-notifications/notifications/notifications-service-and-notifications-providers">Notifications Provider</see>.</param>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.Dismiss(System.Collections.Generic.IEnumerable{DevExpress.Persistent.Base.General.INotificationItem})">
      <summary>
        <para>Removes the specified notification items.</para>
      </summary>
      <param name="itemsToDismiss">An IEnumerable&lt;<see cref="T:DevExpress.Persistent.Base.General.INotificationItem"/>&gt; list of notification items to be dismissed.</param>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.Dispose">
      <summary>
        <para>Releases all resources used by an <see cref="T:DevExpress.ExpressApp.Notifications.NotificationsService"/> object.</para>
      </summary>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.GetActiveNotificationsCount">
      <summary>
        <para>Returns the number of active notifications.</para>
      </summary>
      <returns>An integer value which is the number of active notifications.</returns>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.GetPostponedNotificationsCount">
      <summary>
        <para>Returns the number of postponed notifications.</para>
      </summary>
      <returns>An integer value which is the number of postponed notifications.</returns>
    </member>
    <member name="E:DevExpress.ExpressApp.Notifications.NotificationsService.ItemsProcessed">
      <summary>
        <para>Occurs when an <see cref="T:DevExpress.Persistent.Base.General.ISupportNotifications"/> object is changed.</para>
      </summary>
    </member>
    <member name="E:DevExpress.ExpressApp.Notifications.NotificationsService.NotificationsChanged">
      <summary>
        <para>For internal use.</para>
      </summary>
    </member>
    <member name="P:DevExpress.ExpressApp.Notifications.NotificationsService.NotificationsProviders">
      <summary>
        <para>Gets a list of registered <see href="https://docs.devexpress.com/eXpressAppFramework/113693/event-planning-and-notifications/notifications/notifications-service-and-notifications-providers">Notifications Providers</see>.</para>
      </summary>
      <value>A ReadOnlyCollection&lt;<see cref="T:DevExpress.Persistent.Base.General.INotificationsProvider"/>&gt; list of objects that provide notifications.</value>
    </member>
    <member name="E:DevExpress.ExpressApp.Notifications.NotificationsService.NotificationTriggered">
      <summary>
        <para>Occurs when there are notifications to display.</para>
      </summary>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.Postpone(System.Collections.Generic.IEnumerable{DevExpress.Persistent.Base.General.INotificationItem},System.TimeSpan)">
      <summary>
        <para>Postpones the specified notification items for the given amount of time.</para>
      </summary>
      <param name="itemsToPostpone">An IEnumerable&lt;<see cref="T:DevExpress.Persistent.Base.General.INotificationItem"/>&gt; object to be dismissed.</param>
      <param name="postponeTime">A <see cref="T:System.TimeSpan"/> object that specifies the amount of time to postpone the notification.</param>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.Refresh">
      <summary>
        <para>Refreshes the list of active notifications.</para>
      </summary>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.RefreshNotifications">
      <summary>
        <para>For internal use.</para>
      </summary>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.RegisterNotificationsProvider(DevExpress.Persistent.Base.General.INotificationsProvider)">
      <summary>
        <para>Registers the specified <see href="https://docs.devexpress.com/eXpressAppFramework/113693/event-planning-and-notifications/notifications/notifications-service-and-notifications-providers">Notifications Provider</see></para>
      </summary>
      <param name="notificationProvider">An <see cref="T:DevExpress.Persistent.Base.General.INotificationsProvider"/> object to register.</param>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.SetItemChanged(DevExpress.Persistent.Base.General.INotificationItem)">
      <summary>
        <para>For internal use.</para>
      </summary>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.UnregisterNotificationsProvider(DevExpress.Persistent.Base.General.INotificationsProvider)">
      <summary>
        <para>Unregisters the specified <see href="https://docs.devexpress.com/eXpressAppFramework/113693/event-planning-and-notifications/notifications/notifications-service-and-notifications-providers">Notifications Provider</see></para>
      </summary>
      <param name="notificationProvider">An <see cref="T:DevExpress.Persistent.Base.General.INotificationsProvider"/> object to register.</param>
    </member>
    <member name="M:DevExpress.ExpressApp.Notifications.NotificationsService.UpdateDefaultNotificationsProvider(DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider)">
      <summary>
        <para>Recreates the <see cref="T:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider"/>.</para>
      </summary>
      <param name="newDefaultNotificationsProvider">The <see cref="T:DevExpress.ExpressApp.Notifications.DefaultNotificationsProvider"/> that specifies the new default <see href="https://docs.devexpress.com/eXpressAppFramework/113693/event-planning-and-notifications/notifications/notifications-service-and-notifications-providers">Notifications Provider</see></param>
    </member>
  </members>
</doc>