ozone/tools.ozone.moderation/QueryEventsQueryParams

QueryEventsQueryParams

@Serializable
data class QueryEventsQueryParams(val types: ReadOnlyList<String> = persistentListOf(), val createdBy: Did? = null, val sortDirection: String? = "desc", val createdAfter: Timestamp? = null, val createdBefore: Timestamp? = null, val subject: Uri? = null, val collections: ReadOnlyList<Nsid> = persistentListOf(), val subjectType: QueryEventsSubjectType? = null, val includeAllUserRecords: Boolean? = false, val limit: Long? = 50, val hasComment: Boolean? = null, val comment: String? = null, val addedLabels: ReadOnlyList<String> = persistentListOf(), val removedLabels: ReadOnlyList<String> = persistentListOf(), val addedTags: ReadOnlyList<String> = persistentListOf(), val removedTags: ReadOnlyList<String> = persistentListOf(), val reportTypes: ReadOnlyList<String> = persistentListOf(), val cursor: String? = null)

Parameters

types

The types of events (fully qualified string in the format of tools.ozone.moderation.defs#modEvent) to filter by. If not specified, all events are returned.

sortDirection

Sort direction for the events. Defaults to descending order of created at timestamp.

createdAfter

Retrieve events created after a given timestamp

createdBefore

Retrieve events created before a given timestamp

collections

If specified, only events where the subject belongs to the given collections will be returned. When subjectType is set to 'account', this will be ignored.

subjectType

If specified, only events where the subject is of the given type (account or record) will be returned. When this is set to 'account' the 'collections' parameter will be ignored. When includeAllUserRecords or subject is set, this will be ignored.

includeAllUserRecords

If true, events on all record types (posts, lists, profile etc.) or records from given 'collections' param, owned by the did are returned.

hasComment

If true, only events with comments are returned

comment

If specified, only events with comments containing the keyword are returned

addedLabels

If specified, only events where all of these labels were added are returned

removedLabels

If specified, only events where all of these labels were removed are returned

addedTags

If specified, only events where all of these tags were added are returned

removedTags

If specified, only events where all of these tags were removed are returned

Constructors

Link copied to clipboard
constructor(types: ReadOnlyList<String> = persistentListOf(), createdBy: Did? = null, sortDirection: String? = "desc", createdAfter: Timestamp? = null, createdBefore: Timestamp? = null, subject: Uri? = null, collections: ReadOnlyList<Nsid> = persistentListOf(), subjectType: QueryEventsSubjectType? = null, includeAllUserRecords: Boolean? = false, limit: Long? = 50, hasComment: Boolean? = null, comment: String? = null, addedLabels: ReadOnlyList<String> = persistentListOf(), removedLabels: ReadOnlyList<String> = persistentListOf(), addedTags: ReadOnlyList<String> = persistentListOf(), removedTags: ReadOnlyList<String> = persistentListOf(), reportTypes: ReadOnlyList<String> = persistentListOf(), cursor: String? = null)

Properties

Link copied to clipboard
val addedLabels: ReadOnlyList<String>

If specified, only events where all of these labels were added are returned

Link copied to clipboard
val addedTags: ReadOnlyList<String>

If specified, only events where all of these tags were added are returned

Link copied to clipboard
val collections: ReadOnlyList<Nsid>

If specified, only events where the subject belongs to the given collections will be returned. When subjectType is set to 'account', this will be ignored.

Link copied to clipboard
val comment: String? = null

If specified, only events with comments containing the keyword are returned

Link copied to clipboard
val createdAfter: Timestamp? = null

Retrieve events created after a given timestamp

Link copied to clipboard
val createdBefore: Timestamp? = null

Retrieve events created before a given timestamp

Link copied to clipboard
val createdBy: Did? = null
Link copied to clipboard
val cursor: String? = null
Link copied to clipboard
val hasComment: Boolean? = null

If true, only events with comments are returned

Link copied to clipboard
val includeAllUserRecords: Boolean? = false

If true, events on all record types (posts, lists, profile etc.) or records from given 'collections' param, owned by the did are returned.

Link copied to clipboard
val limit: Long? = 50
Link copied to clipboard
val removedLabels: ReadOnlyList<String>

If specified, only events where all of these labels were removed are returned

Link copied to clipboard
val removedTags: ReadOnlyList<String>

If specified, only events where all of these tags were removed are returned

Link copied to clipboard
Link copied to clipboard
val sortDirection: String?

Sort direction for the events. Defaults to descending order of created at timestamp.

Link copied to clipboard
val subject: Uri? = null
Link copied to clipboard
val subjectType: QueryEventsSubjectType? = null

If specified, only events where the subject is of the given type (account or record) will be returned. When this is set to 'account' the 'collections' parameter will be ignored. When includeAllUserRecords or subject is set, this will be ignored.

Link copied to clipboard
val types: ReadOnlyList<String>

The types of events (fully qualified string in the format of tools.ozone.moderation.defs#modEvent) to filter by. If not specified, all events are returned.

Functions

Link copied to clipboard