INotificationServiceNotificationQuery Method

Gets the notifications corresponding to query criteria.

Namespace: Dundas.BI.Notifications
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (26.2.0.1000)

Syntax

C++

Copy

IList<Notification> NotificationQuery(
	int pageNumber,
	int pageSize,
	IList<Tuple<NotificationQueryField, SortDirection>>? orderBy,
	ICollection<NotificationQueryFilterRule>? filter
)

Function NotificationQuery ( 
	pageNumber As Integer,
	pageSize As Integer,
	orderBy As IList(Of Tuple(Of NotificationQueryField, SortDirection)),
	filter As ICollection(Of NotificationQueryFilterRule)
) As IList(Of Notification)

IList<Notification^>^ NotificationQuery(
	int pageNumber, 
	int pageSize, 
	IList<Tuple<NotificationQueryField, SortDirection>^>^ orderBy, 
	ICollection<NotificationQueryFilterRule^>^ filter
)

abstract NotificationQuery : 
        pageNumber : int * 
        pageSize : int * 
        orderBy : IList<Tuple<NotificationQueryField, SortDirection>> * 
        filter : ICollection<NotificationQueryFilterRule> -> IList<Notification>

Parameters

pageNumber Int32: The page number, or 0 to indicate that all pages should be returned.
pageSize Int32: The number of results in each page (ignored if pageNumber is 0).
orderBy IListTupleNotificationQueryField, SortDirection: The sort order of the result, or if the order does not matter.
filter ICollectionNotificationQueryFilterRule: The filter rules which should be applied to the query, or if no filters are required.

Return Value

IListNotification
The collection of Notification objects matching the query criteria.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	pageNumber is less than zero; -or- pageSize is less or equal to than zero.
InvalidOperationException	filter contains an invalid rule.
NoPrivilegeException	The caller is not a system administrator or a tenant administrator.
InvalidSessionException	The caller context is not associated with a valid session.

Remarks

Note
For performance reasons, the detailed content is not included in notifications objects returned by this method.

Note
Specifying or Empty for filter disables any filtering.

Reference

INotificationService Interface

Dundas.BI.Notifications Namespace