SDK Reference v2.0.0 / NotificationHistoryQuery
NotificationHistoryQuery
struct NotificationHistoryQuery : PagedQuery
Specifies filtering and page-navigation criteria for participant notification queries.
All query properties are optional. Set non-nil/non-default values only for the properties you want to use for filtering.
defaultLimit
static let defaultLimit: Int
The default and maximum number of results per page.
identifier
let identifier: String?
Name of the configured notification.
sentAfter
let sentAfter: Date?
Notifications sent after this date.
sentBefore
let sentBefore: Date?
Notifications sent before this date.
type
let type: NotificationType?
statusCode
let statusCode: NotificationSendStatusCode?
Describes whether the notification was sent.
limit
let limit: Int
Maximum number of results per page. Default and maximum value is 100.
pageID
let pageID: NotificationHistoryPage.PageID?
Identifies a specific page of notifications to fetch. Use nil to fetch the first page of results. To fetch the page following a given NotificationHistoryPage use its nextPageID; the other parameters should be the same as the original NotificationHistoryQuery.
init(identifier: sentAfter: sentBefore: type: statusCode: limit: pageID:)
init(identifier: String? = nil, sentAfter: Date? = nil, sentBefore: Date? = nil, type: NotificationType? = nil, statusCode: NotificationSendStatusCode? = nil, limit: Int = defaultLimit, pageID: NotificationHistoryPage.PageID? = nil)
Initializes a new query for a page of notifications with various filters.
identifier
Name of the configured notification.
sentAfter
Notifications sent after this date.
sentBefore
Notifications sent before this date.
statusCode
Describes whether the notification was sent.
limit
Maximum number of results per page.
pageID
Identifies a specific page of notifications to fetch.
page(after:)
func page(after page: NotificationHistoryPage) -> NotificationHistoryQuery?
Creates a copy of this query for a page of results following the given page, with the same filters as the original query.
page
The previous page of results, which should have been produced with this query.