tools.ozone.moderation.query_events¶
- class atproto_client.models.tools.ozone.moderation.query_events.Params¶
Bases:
ParamsModelBase
Parameters model for
tools.ozone.moderation.queryEvents
.- field added_labels: List[str] | None = None¶
- field added_tags: List[str] | None = None¶
- field collections: List[str[str]] | None = None¶
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.
- Constraints:
max_length = 20
- field comment: str | None = None¶
- field created_after: str | None = None¶
Retrieve events created after a given timestamp.
- field created_before: str | None = None¶
Retrieve events created before a given timestamp.
- field created_by: str | None = None¶
Created by.
- field cursor: str | None = None¶
Cursor.
- field has_comment: bool | None = None¶
If true, only events with comments are returned.
- field include_all_user_records: bool | None = False¶
- field limit: int | None = 50¶
Limit.
- Constraints:
ge = 1
le = 100
- field policies: List[str] | None = None¶
Policies.
- field removed_labels: List[str] | None = None¶
- field removed_tags: List[str] | None = None¶
- field report_types: List[str] | None = None¶
Report types.
- field sort_direction: Literal['asc'] | Literal['desc'] | None = 'desc'¶
- field subject: str | None = None¶
Subject.
- field subject_type: Literal['account'] | Literal['record'] | str | None = None¶
- field types: List[str] | None = None¶
- class atproto_client.models.tools.ozone.moderation.query_events.ParamsDict(*args, **kwargs)¶
Bases:
dict
- added_labels: typing_extensions.NotRequired[List[str] | None]¶
If specified, only events where all of these labels were added are returned.
- added_tags: typing_extensions.NotRequired[List[str] | None]¶
If specified, only events where all of these tags were added are returned.
- collections: typing_extensions.NotRequired[List[str[str]] | None]¶
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.
- comment: typing_extensions.NotRequired[str | None]¶
If specified, only events with comments containing the keyword are returned. Apply || separator to use multiple keywords and match using OR condition.
- created_after: typing_extensions.NotRequired[str[str] | None]¶
Retrieve events created after a given timestamp.
- created_before: typing_extensions.NotRequired[str[str] | None]¶
Retrieve events created before a given timestamp.
- created_by: typing_extensions.NotRequired[str[str] | None]¶
Created by.
- cursor: typing_extensions.NotRequired[str | None]¶
Cursor.
- has_comment: typing_extensions.NotRequired[bool | None]¶
If true, only events with comments are returned.
- include_all_user_records: typing_extensions.NotRequired[bool | None]¶
If true, events on all record types (posts, lists, profile etc.) or records from given ‘collections’ param, owned by the did are returned.
- limit: typing_extensions.NotRequired[int | None]¶
Limit.
- policies: typing_extensions.NotRequired[List[str] | None]¶
Policies.
- removed_labels: typing_extensions.NotRequired[List[str] | None]¶
If specified, only events where all of these labels were removed are returned.
- removed_tags: typing_extensions.NotRequired[List[str] | None]¶
If specified, only events where all of these tags were removed are returned.
- report_types: typing_extensions.NotRequired[List[str] | None]¶
Report types.
- sort_direction: typing_extensions.NotRequired[Literal['asc'] | Literal['desc'] | None]¶
Sort direction for the events. Defaults to descending order of created at timestamp.
- subject: typing_extensions.NotRequired[str[str] | None]¶
Subject.
- subject_type: typing_extensions.NotRequired[Literal['account'] | Literal['record'] | str | None]¶
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.
- types: typing_extensions.NotRequired[List[str] | None]¶
The types of events (fully qualified string in the format of tools.ozone.moderation.defs#modEvent<name>) to filter by. If not specified, all events are returned.
- class atproto_client.models.tools.ozone.moderation.query_events.Response¶
Bases:
ResponseModelBase
Output data model for
tools.ozone.moderation.queryEvents
.- field cursor: str | None = None¶
Cursor.
- field events: List[models.ToolsOzoneModerationDefs.ModEventView] [Required]¶
Events.