tools.ozone.moderation.scheduleAction
#main
Schedule a moderation action to be executed at a future time
Input
- Encoding: application/json
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| action | union of #takedown | - | ✅ | - |
| subjects | array of string | - | ✅ | Array of DID subjects to schedule the action for |
| createdBy | string (did) | - | ✅ | - |
| scheduling | #schedulingConfig | - | ✅ | - |
| modTool | tools.ozone.moderation.defs#modTool | - | ❌ | - |
Output
- Encoding: application/json
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| ref | #scheduledActionResults | - | ✅ | - |
#takedown
Schedule a takedown action
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| comment | string | - | ❌ | - |
| durationInHours | integer | - | ❌ | Indicates how long the takedown should be in effect before automatically expiring. |
| acknowledgeAccountSubjects | boolean | - | ❌ | If true, all other reports on content authored by this account will be resolved (acknowledged). |
| policies | array of string | - | ❌ | Names/Keywords of the policies that drove the decision. |
| severityLevel | string | - | ❌ | Severity level of the violation (e.g., 'sev-0', 'sev-1', 'sev-2', etc.). |
| strikeCount | integer | - | ❌ | Number of strikes to assign to the user when takedown is applied. |
| strikeExpiresAt | string (datetime) | - | ❌ | When the strike should expire. If not provided, the strike never expires. |
| emailContent | string | - | ❌ | Email content to be sent to the user upon takedown. |
| emailSubject | string | - | ❌ | Subject of the email to be sent to the user upon takedown. |
#schedulingConfig
Configuration for when the action should be executed
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| executeAt | string (datetime) | - | ❌ | Exact time to execute the action |
| executeAfter | string (datetime) | - | ❌ | Earliest time to execute the action (for randomized scheduling) |
| executeUntil | string (datetime) | - | ❌ | Latest time to execute the action (for randomized scheduling) |
#scheduledActionResults
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| succeeded | array of string | - | ✅ | - |
| failed | array of #failedScheduling | - | ✅ | - |
#failedScheduling
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| subject | string (did) | - | ✅ | - |
| error | string | - | ✅ | - |
| errorCode | string | - | ❌ | - |