• Get Review Board
  • What's New
  • Products
  • Review Board Code review, image review, and document review
  • Documentation
  • Release Notes
  • Power Pack Enterprise integrations, reports, and enhanced document review
  • Try for 60 Days
  • Purchase
  • RBCommons Review Board as a Service, hosted by us
  • Pricing
  • RBTools Command line tools and Python API for Review Board
  • Documentation
  • Release Notes
  • Review Bot Automated code review, connecting tools you already use
  • Documentation
  • Release Notes
  • RB Gateway Manage Git and Mercurial repositories in your network
  • Documentation
  • Release Notes
  • Learn and Explore
  • What is Code Review?
  • Documentation
  • Frequently Asked Questions
  • Support Options
  • Third-Party Integrations
  • Demo
  • Review Board RBTools Power Pack Review Bot Djblets RB Gateway
    1. Review Board 7.x
    2. Version 7.x
    3. Version 6.x
    4. Version 5.0
    5. Version 4.0
    6. Version 3.0
    7. Version 2.5
    8. Version 2.0
    9. Version 1.7
    10. Version 1.6
    11. Version 1.5
    12. Version 1.0
    13. Extending Review Board
    14. Module and Class References
    15. reviewboard.reviews.actions
  • Home
  • Users Guide
  • Getting Started
  • Introduction
  • What is Code Review?
  • Review Board Workflows
  • Account Settings
  • Dashboard
  • Working with Review Requests
  • Overview
  • Creating Review Requests
  • Editing Fields
  • Uploading Diffs
  • Uploading File Attachments
  • Publishing Review Requests
  • Closing Review Requests
  • Reviewing
  • Reviews and Comments
  • The Review Banner
  • Managing and Publishing Drafts
  • Issue Tracking
  • Reviewing Code (Diffs)
  • Reviewing File Attachments
  • Reviewing Images
  • Reviewing Markdown Files
  • Reviewing Text Files
  • Creating and Editing Reviews
  • Approving Changes (Ship It!)
  • Replying to Comments
  • Automated Code Reviews
  • Searching
  • Quick Search
  • Full-Text Search
  • Using Markdown
  • Administration Guide
  • Installation
  • Installing Review Board
  • Linux System Compatibility
  • Installing with Docker
  • Manually Installing on Linux
  • Installing on macOS
  • Installing on Windows
  • Installing Development Releases
  • Creating a Review Board Site
  • Upgrading
  • Upgrading Review Board
  • Upgrading Review Board Sites
  • Optimization
  • Optimizing and Scaling Review Board
  • Administration UI
  • Overview of the Administration UI
  • Administrator Dashboard
  • Database Management
  • Configuration
  • Site Settings
  • General Settings
  • Authentication Settings
  • Avatar Services Settings
  • E-Mail Settings
  • Diff Viewer Settings
  • Logging Settings
  • SSH Settings
  • File Storage Settings
  • User Privacy Settings
  • Search Settings
  • Access Control
  • Working with E-Mail
  • Default Reviewers
  • Permission Groups
  • Repositories
  • Bazaar Repositories
  • CVS Repositories
  • Git Repositories
  • HCL VersionVault and IBM ClearCase
  • Mercurial Repositories
  • Perforce Repositories
  • Subversion Repositories
  • Assembla Repositories
  • AWS CodeCommit Repositories
  • Beanstalk Repositories
  • Bitbucket Repositories
  • Bitbucket Server Repositories
  • Codebase HQ Repositories
  • Fedora Hosted Repositories
  • Gerrit Repositories
  • GitHub Repositories
  • GitHub Enterprise Repositories
  • GitLab Repositories
  • Gitorious Repositories
  • Cliosoft SOS Repositories
  • SourceForge Repositories
  • Unfuddle STACK Repositories
  • VisualStudio.com Repositories
  • Review Groups
  • Users
  • WebHooks
  • Extensions
  • Integrations
  • Asana Integration
  • CircleCI Integration
  • Discord Integration
  • I Done This Integration
  • Jenkins CI Integration
  • Matrix Integration
  • Mattermost Integration
  • Microsoft Teams Integration
  • Slack Integration
  • Travis CI Integration
  • Trello Integration
  • Site Maintenance
  • The rb-site Tool
  • Advanced Management Commands
  • Monitoring Review Board
  • Health Checks
  • Web API Guide
  • Resource Tree
  • Resources
  • Root List Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Extension List Resource
  • Extension Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Info Resource
  • Repository User List Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Request List Resource
  • Review Request Resource
  • Change List Resource
  • Diff Context Resource
  • Diff List Resource
  • File Attachment List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Status Update List Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Root Review List Resource
  • Search Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • API Token List Resource
  • Archived Review Request List Resource
  • Muted Review Request List Resource
  • User File Attachment List Resource
  • Watched List Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • Server Info Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Default Reviewer Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • File Diff List Resource
  • File Diff Resource
  • Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • Diff Commit Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Diff File Attachment Resource
  • Original File Resource
  • Patched File Resource
  • Extension List Resource
  • Extension Resource
  • Extension Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • Hosting Service Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository User Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User Resource
  • Change List Resource
  • Change Resource
  • Change Resource
  • File Attachment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Comment List Resource
  • Review Request List Resource
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • File Attachment List Resource
  • File Attachment Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft File Attachment List Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Status Update List Resource
  • Status Update Resource
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • File Diff List Resource
  • File Attachment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review File Attachment Comment List Resource
  • Review General Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Status Update List Resource
  • Status Update Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Comment List Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft File Attachment Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft File Diff List Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Root Review List Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply General Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review General Comment Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Search Resource
  • Status Update List Resource
  • Status Update Resource
  • Status Update Resource
  • API Token List Resource
  • API Token Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • Muted Review Request Resource
  • Session Resource
  • User List Resource
  • User Resource
  • API Token List Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • User Resource
  • API Token List Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • User File Attachment Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • WebHook Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 102 - Invalid Attribute
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 106 - Missing Attribute
  • 107 - Enable Extension Failed
  • 108 - Disable Extension Failed
  • 109 - Extension Already Installed
  • 110 - Install Extension Failed
  • 111 - Duplicate Item
  • 112 - OAuth2 Missing Scope Error
  • 113 - OAuth2 Access Denied Error
  • 114 - Rate Limit Exceeded
  • 203 - Invalid Change Number
  • 204 - Change Number In Use
  • 205 - Missing Repository
  • 206 - Invalid Repository
  • 207 - Repository File Not Found
  • 208 - Invalid User
  • 209 - Repository Action Not Supported
  • 210 - Repository Information Error
  • 212 - Empty Changeset
  • 213 - Server Configuration Error
  • 214 - Bad Host Key
  • 215 - Unverified Host Key
  • 216 - Unverified Host Certificate
  • 217 - Missing User Key
  • 218 - Repository Authentication Error
  • 219 - Diff Empty
  • 220 - Diff Too Big
  • 221 - File Retrieval Error
  • 222 - Hosting Service Authentication Error
  • 223 - Group Already Exists
  • 224 - Diff Parse Error
  • 225 - Publish Error
  • 226 - User Query Error
  • 227 - Commit ID Already Exists
  • 228 - Token Generation Failed
  • 230 - Could not close review request
  • 231 - Could not reopen review request
  • 232 - Ship-It Revocation Error
  • REST API 2.0
  • Overview
  • Authenticating
  • API Token Policies
  • OAuth2 Authentication
  • Rich Text Fields and Types
  • Storing/Accessing Extra Data
  • Resources
  • Root List Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Extension List Resource
  • Extension Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Request List Resource
  • Review Request Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Root Review List Resource
  • Search Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • Server Info Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Default Reviewer Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • File Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • File Diff List Resource
  • File Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • Diff Commit Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Diff File Attachment Resource
  • Original File Resource
  • Patched File Resource
  • Extension List Resource
  • Extension Resource
  • Extension Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • Hosting Service Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository User Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User Resource
  • Change List Resource
  • Change Resource
  • Change Resource
  • File Attachment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Comment List Resource
  • Review Request List Resource
  • Review Request Resource
  • Change List Resource
  • Diff Context Resource
  • Diff List Resource
  • File Attachment List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Status Update List Resource
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • File Attachment List Resource
  • File Attachment Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft File Attachment List Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Status Update List Resource
  • Status Update Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Comment List Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft File Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft File Attachment Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Root Review List Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review File Attachment Comment List Resource
  • Review General Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review General Comment Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply General Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Search Resource
  • Status Update List Resource
  • Status Update Resource
  • Status Update Resource
  • API Token List Resource
  • API Token Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • Muted Review Request Resource
  • Session Resource
  • User List Resource
  • User Resource
  • API Token List Resource
  • Archived Review Request List Resource
  • Muted Review Request List Resource
  • User File Attachment List Resource
  • Watched List Resource
  • User Resource
  • API Token List Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • User File Attachment Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • WebHook Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 102 - Invalid Attribute
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 106 - Missing Attribute
  • 107 - Enable Extension Failed
  • 108 - Disable Extension Failed
  • 109 - Extension Already Installed
  • 110 - Install Extension Failed
  • 111 - Duplicate Item
  • 112 - OAuth2 Missing Scope Error
  • 113 - OAuth2 Access Denied Error
  • 114 - Rate Limit Exceeded
  • 203 - Invalid Change Number
  • 204 - Change Number In Use
  • 205 - Missing Repository
  • 206 - Invalid Repository
  • 207 - Repository File Not Found
  • 208 - Invalid User
  • 209 - Repository Action Not Supported
  • 210 - Repository Information Error
  • 212 - Empty Changeset
  • 213 - Server Configuration Error
  • 214 - Bad Host Key
  • 215 - Unverified Host Key
  • 216 - Unverified Host Certificate
  • 217 - Missing User Key
  • 218 - Repository Authentication Error
  • 219 - Diff Empty
  • 220 - Diff Too Big
  • 221 - File Retrieval Error
  • 222 - Hosting Service Authentication Error
  • 223 - Group Already Exists
  • 224 - Diff Parse Error
  • 225 - Publish Error
  • 226 - User Query Error
  • 227 - Commit ID Already Exists
  • 228 - Token Generation Failed
  • 230 - Could not close review request
  • 231 - Could not reopen review request
  • 232 - Ship-It Revocation Error
  • Glossary
  • Extending Review Board
  • Extension Files/Package Layout
  • Creating an Extension Class
  • Extension Configuration
  • Database Models
  • Extension Static Media Files
  • JavaScript Extensions
  • Testing Extensions
  • Extension Distribution
  • Writing Review Board Extensions
  • The rbext Tool
  • Extension Hooks
  • AccountPageFormsHook
  • AccountPagesHook
  • Action Hooks
  • AdminWidgetHook
  • APIExtraDataAccessHook
  • AuthBackendHook
  • AvatarServiceHook
  • CommentDetailDisplayHook
  • DashboardColumnsHook
  • DashboardSidebarItemsHook
  • DataGridColumnsHook
  • EmailHook
  • ReviewRequestPublishedEmailHook
  • ReviewRequestClosedEmailHook
  • ReviewPublishedEmailHook
  • ReviewReplyPublishedEmailHook
  • FileAttachmentThumbnailHook
  • FileDiffACLHook
  • HostingServiceHook
  • IntegrationHook
  • NavigationBarHook
  • ReviewRequestApprovalHook
  • ReviewRequestFieldsHook
  • ReviewRequestFieldSetsHook
  • ReviewUIHook
  • SCMToolHook
  • SignalHook
  • TemplateHook
  • URLHook
  • UserInfoboxHook
  • UserPageSidebarItemsHook
  • WebAPICapabilitiesHook
  • JavaScript Extension Hooks
  • CommentDialogHook
  • FileAttachmentThumbnailContainerHook
  • ReviewDialogCommentHook
  • ReviewDialogHook
  • Adding Review Request Fields
  • Review UI Integration
  • Writing Authentication Backends
  • Writing Legacy Authentication Backends
  • Extending the Web API
  • Module and Class References
  • reviewboard
  • reviewboard.deprecation
  • reviewboard.rb_platform
  • reviewboard.signals
  • reviewboard.accounts.backends
  • reviewboard.accounts.backends.ad
  • reviewboard.accounts.backends.base
  • reviewboard.accounts.backends.http_digest
  • reviewboard.accounts.backends.ldap
  • reviewboard.accounts.backends.nis
  • reviewboard.accounts.backends.registry
  • reviewboard.accounts.backends.standard
  • reviewboard.accounts.backends.x509
  • reviewboard.accounts.decorators
  • reviewboard.accounts.errors
  • reviewboard.accounts.forms.auth
  • reviewboard.accounts.forms.pages
  • reviewboard.accounts.forms.registration
  • reviewboard.accounts.managers
  • reviewboard.accounts.middleware
  • reviewboard.accounts.mixins
  • reviewboard.accounts.models
  • reviewboard.accounts.pages
  • reviewboard.accounts.privacy
  • reviewboard.accounts.templatetags.accounts
  • reviewboard.accounts.testing
  • reviewboard.accounts.testing.queries
  • reviewboard.accounts.trophies
  • reviewboard.actions
  • reviewboard.actions.base
  • reviewboard.actions.errors
  • reviewboard.actions.registry
  • reviewboard.admin
  • reviewboard.admin.admin_sites
  • reviewboard.admin.cache_stats
  • reviewboard.admin.checks
  • reviewboard.admin.decorators
  • reviewboard.admin.form_widgets
  • reviewboard.admin.middleware
  • reviewboard.admin.model_admin
  • reviewboard.admin.security_checks
  • reviewboard.admin.server
  • reviewboard.admin.siteconfig
  • reviewboard.admin.support
  • reviewboard.admin.validation
  • reviewboard.admin.widgets
  • reviewboard.attachments.errors
  • reviewboard.attachments.forms
  • reviewboard.attachments.managers
  • reviewboard.attachments.mimetypes
  • reviewboard.attachments.models
  • reviewboard.avatars.registry
  • reviewboard.avatars.services
  • reviewboard.avatars.settings
  • reviewboard.avatars.templatetags.avatars
  • reviewboard.avatars.testcase
  • reviewboard.changedescs.models
  • reviewboard.datagrids.columns
  • reviewboard.datagrids.grids
  • reviewboard.datagrids.sidebar
  • reviewboard.diffviewer.chunk_generator
  • reviewboard.diffviewer.differ
  • reviewboard.diffviewer.diffutils
  • reviewboard.diffviewer.errors
  • reviewboard.diffviewer.forms
  • reviewboard.diffviewer.managers
  • reviewboard.diffviewer.models
  • reviewboard.diffviewer.models.diffcommit
  • reviewboard.diffviewer.models.diffset
  • reviewboard.diffviewer.models.diffset_history
  • reviewboard.diffviewer.models.filediff
  • reviewboard.diffviewer.models.legacy_file_diff_data
  • reviewboard.diffviewer.models.raw_file_diff_data
  • reviewboard.diffviewer.myersdiff
  • reviewboard.diffviewer.opcode_generator
  • reviewboard.diffviewer.parser
  • reviewboard.diffviewer.processors
  • reviewboard.diffviewer.renderers
  • reviewboard.diffviewer.smdiff
  • reviewboard.certs
  • reviewboard.certs.cert
  • reviewboard.certs.errors
  • reviewboard.extensions.base
  • reviewboard.extensions.hooks
  • reviewboard.extensions.packaging
  • reviewboard.extensions.testing
  • reviewboard.extensions.testing.testcases
  • reviewboard.hostingsvcs.base
  • reviewboard.hostingsvcs.base.client
  • reviewboard.hostingsvcs.base.forms
  • reviewboard.hostingsvcs.base.hosting_service
  • reviewboard.hostingsvcs.base.http
  • reviewboard.hostingsvcs.base.paginator
  • reviewboard.hostingsvcs.base.registry
  • reviewboard.hostingsvcs.base.repository
  • reviewboard.hostingsvcs.errors
  • reviewboard.hostingsvcs.forms
  • reviewboard.hostingsvcs.hook_utils
  • reviewboard.hostingsvcs.models
  • reviewboard.hostingsvcs.repository
  • reviewboard.hostingsvcs.service
  • reviewboard.hostingsvcs.testing
  • reviewboard.hostingsvcs.testing.testcases
  • reviewboard.hostingsvcs.utils.paginator
  • reviewboard.integrations
  • reviewboard.integrations.base
  • reviewboard.integrations.forms
  • reviewboard.integrations.models
  • reviewboard.integrations.urls
  • reviewboard.integrations.views
  • reviewboard.notifications
  • reviewboard.notifications.email
  • reviewboard.notifications.email.backend
  • reviewboard.notifications.email.decorators
  • reviewboard.notifications.email.hooks
  • reviewboard.notifications.email.message
  • reviewboard.notifications.email.utils
  • reviewboard.notifications.email.views
  • reviewboard.notifications.forms
  • reviewboard.notifications.managers
  • reviewboard.notifications.models
  • reviewboard.notifications.webhooks
  • reviewboard.reviews.actions
  • reviewboard.reviews.builtin_fields
  • reviewboard.reviews.chunk_generators
  • reviewboard.reviews.conditions
  • reviewboard.reviews.context
  • reviewboard.reviews.default_actions
  • reviewboard.reviews.detail
  • reviewboard.reviews.errors
  • reviewboard.reviews.features
  • reviewboard.reviews.fields
  • reviewboard.reviews.forms
  • reviewboard.reviews.managers
  • reviewboard.reviews.markdown_utils
  • reviewboard.reviews.models
  • reviewboard.reviews.signals
  • reviewboard.reviews.templatetags.reviewtags
  • reviewboard.reviews.testing
  • reviewboard.reviews.testing.queries
  • reviewboard.reviews.testing.queries.review_groups
  • reviewboard.reviews.testing.queries.review_requests
  • reviewboard.reviews.testing.queries.reviews
  • reviewboard.reviews.ui.base
  • reviewboard.reviews.ui.image
  • reviewboard.reviews.ui.markdownui
  • reviewboard.reviews.ui.text
  • reviewboard.reviews.views.attachments
  • reviewboard.reviews.views.bug_trackers
  • reviewboard.reviews.views.diff_fragments
  • reviewboard.reviews.views.diffviewer
  • reviewboard.reviews.views.download_diff
  • reviewboard.reviews.views.email
  • reviewboard.reviews.views.mixins
  • reviewboard.reviews.views.new_review_request
  • reviewboard.reviews.views.review_request_detail
  • reviewboard.reviews.views.review_request_infobox
  • reviewboard.reviews.views.review_request_updates
  • reviewboard.reviews.views.root
  • reviewboard.scmtools.certs
  • reviewboard.scmtools.conditions
  • reviewboard.scmtools.core
  • reviewboard.scmtools.crypto_utils
  • reviewboard.scmtools.errors
  • reviewboard.scmtools.forms
  • reviewboard.scmtools.managers
  • reviewboard.scmtools.models
  • reviewboard.scmtools.signals
  • reviewboard.scmtools.testing
  • reviewboard.scmtools.testing.queries
  • reviewboard.scmtools.tests.testcases
  • reviewboard.search.fields
  • reviewboard.search.forms
  • reviewboard.search.indexes
  • reviewboard.search.search_backends.base
  • reviewboard.search.search_backends.elasticsearch
  • reviewboard.search.search_backends.registry
  • reviewboard.search.search_backends.whoosh
  • reviewboard.search.signal_processor
  • reviewboard.search.testing
  • reviewboard.site.conditions
  • reviewboard.site.context_processors
  • reviewboard.site.decorators
  • reviewboard.site.middleware
  • reviewboard.site.mixins
  • reviewboard.site.models
  • reviewboard.site.signals
  • reviewboard.site.templatetags.localsite
  • reviewboard.site.testing
  • reviewboard.site.testing.queries
  • reviewboard.site.urlresolvers
  • reviewboard.site.validation
  • reviewboard.ssh.client
  • reviewboard.ssh.errors
  • reviewboard.ssh.policy
  • reviewboard.ssh.storage
  • reviewboard.ssh.utils
  • reviewboard.testing.hosting_services
  • reviewboard.testing.queries
  • reviewboard.testing.queries.base
  • reviewboard.testing.queries.http
  • reviewboard.testing.scmtool
  • reviewboard.testing.testcase
  • reviewboard.themes
  • reviewboard.themes.context_processors
  • reviewboard.themes.ui
  • reviewboard.themes.ui.base
  • reviewboard.themes.ui.default
  • reviewboard.themes.ui.registry
  • reviewboard.webapi.auth_backends
  • reviewboard.webapi.base
  • reviewboard.webapi.decorators
  • reviewboard.webapi.errors
  • reviewboard.webapi.mixins
  • reviewboard.webapi.models
  • reviewboard.webapi.server_info
  • reviewboard.webapi.testing
  • reviewboard.webapi.testing.queries
  • reviewboard.webapi.tests.base
  • Frequently Asked Questions
  • General Index
  • Python Module Index
  • Release Notes
  • reviewboard.reviews.actions¶

    Actions for the reviews app.

    class CloseMenuAction[source]¶

    Bases: BaseMenuAction

    A menu for closing the review request.

    New in version 6.0.

    action_id: Optional[str] = 'close-menu'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Close'[source]¶

    The user-visible label.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    should_render(*, context: Context) → bool[source]¶

    Return whether this action should render.

    This differs from hidden in that hidden actions still render but are hidden by CSS, whereas if this returns False the action will not be included in the DOM at all.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'children': 'List[str]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class CloseCompletedAction[source]¶

    Bases: BaseAction

    The action to close a review request as completed.

    New in version 6.0.

    action_id: Optional[str] = 'close-completed'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    parent_id: Optional[str] = 'close-menu'[source]¶

    The ID of the parent menu action, if available.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Completed'[source]¶

    The user-visible label.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    js_view_class: str = 'RB.CloseCompletedActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    should_render(*, context: Context) → bool[source]¶

    Return whether this action should render.

    This differs from hidden in that hidden actions still render but are hidden by CSS, whereas if this returns False the action will not be included in the DOM at all.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class CloseDiscardedAction[source]¶

    Bases: BaseAction

    The action to close a review request as discarded.

    New in version 6.0.

    action_id: Optional[str] = 'close-discarded'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    parent_id: Optional[str] = 'close-menu'[source]¶

    The ID of the parent menu action, if available.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Discarded'[source]¶

    The user-visible label.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    js_view_class: str = 'RB.CloseDiscardedActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class DeleteAction[source]¶

    Bases: BaseAction

    The action to permanently delete a review request.

    New in version 6.0.

    action_id: Optional[str] = 'delete-review-request'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    parent_id: Optional[str] = 'close-menu'[source]¶

    The ID of the parent menu action, if available.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Delete Permanently'[source]¶

    The user-visible label.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    js_view_class: str = 'RB.DeleteActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    should_render(*, context: Context) → bool[source]¶

    Return whether this action should render.

    This differs from hidden in that hidden actions still render but are hidden by CSS, whereas if this returns False the action will not be included in the DOM at all.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class DownloadDiffAction[source]¶

    Bases: BaseAction

    The action to download a diff.

    New in version 6.0.

    action_id: Optional[str] = 'download-diff'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Download Diff'[source]¶

    The user-visible label.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    get_url(*, context: Context) → str[source]¶

    Return this action’s URL.

    Parameters:

    context (django.template.Context) – The collection of key-value pairs from the template.

    Returns:

    The URL to invoke if this action is clicked.

    Return type:

    str

    get_visible(*, context: Context) → bool[source]¶

    Return whether the action should start visible or not.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should start visible. False, otherwise.

    Return type:

    bool

    should_render(*, context: Context) → bool[source]¶

    Return whether this action should render.

    This differs from hidden in that hidden actions still render but are hidden by CSS, whereas if this returns False the action will not be included in the DOM at all.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class ReviewMenuAction[source]¶

    Bases: BaseMenuAction

    The “Review” menu on the unified banner.

    New in version 6.0.

    action_id: Optional[str] = 'review-menu'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    attachment: str = 'unified-banner'[source]¶

    The attachment point for the action.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Review'[source]¶

    The user-visible label.

    Type:

    str

    icon_class: Optional[str] = 'rb-icon rb-icon-compose-review'[source]¶

    A class name to use for an icon.

    If specified, this should be the entire class to apply to a <span> element to display an icon. For example, ‘fa fa-rss’.

    Type:

    str

    js_view_class: str = 'RB.ReviewMenuActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    should_render(context: Context) → bool[source]¶

    Return whether this action should render.

    This menu only renders when the user is logged in and the unified banner feature is enabled.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'children': 'List[str]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class CreateReviewAction[source]¶

    Bases: BaseAction

    Action to create a new, blank review.

    New in version 6.0.

    action_id: Optional[str] = 'create-review'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    parent_id: Optional[str] = 'review-menu'[source]¶

    The ID of the parent menu action, if available.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    attachment: str = 'unified-banner'[source]¶

    The attachment point for the action.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Create a new review'[source]¶

    The user-visible label.

    Type:

    str

    description = ['Your review will start off blank, but you can add text and general comments to it.', 'Adding comments to code or file attachments will automatically create a new review for you.'][source]¶
    icon_class: Optional[str] = 'rb-icon rb-icon-create-review'[source]¶

    A class name to use for an icon.

    If specified, this should be the entire class to apply to a <span> element to display an icon. For example, ‘fa fa-rss’.

    Type:

    str

    js_view_class: str = 'RB.CreateReviewActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    template_name: str = 'actions/detailed_menuitem_action.html'[source]¶

    The name of the template to use when rendering.

    Type:

    str

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class EditReviewAction[source]¶

    Bases: BaseAction

    Action to edit an existing review.

    New in version 6.0.

    action_id: Optional[str] = 'edit-review'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    parent_id: Optional[str] = 'review-menu'[source]¶

    The ID of the parent menu action, if available.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    attachment: str = 'unified-banner'[source]¶

    The attachment point for the action.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Edit your review'[source]¶

    The user-visible label.

    Type:

    str

    description = ['Edit your comments and publish your review.'][source]¶
    icon_class: Optional[str] = 'rb-icon rb-icon-compose-review'[source]¶

    A class name to use for an icon.

    If specified, this should be the entire class to apply to a <span> element to display an icon. For example, ‘fa fa-rss’.

    Type:

    str

    js_view_class: str = 'RB.EditReviewActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    template_name: str = 'actions/detailed_menuitem_action.html'[source]¶

    The name of the template to use when rendering.

    Type:

    str

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class AddGeneralCommentAction[source]¶

    Bases: BaseAction

    Action to add a general comment.

    New in version 6.0.

    action_id: Optional[str] = 'add-general-comment'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    parent_id: Optional[str] = 'review-menu'[source]¶

    The ID of the parent menu action, if available.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    attachment: str = 'unified-banner'[source]¶

    The attachment point for the action.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Add a general comment'[source]¶

    The user-visible label.

    Type:

    str

    description = ['Add a new general comment about the change, not attached to any code or file attachments.'][source]¶
    icon_class: Optional[str] = 'rb-icon rb-icon-edit'[source]¶

    A class name to use for an icon.

    If specified, this should be the entire class to apply to a <span> element to display an icon. For example, ‘fa fa-rss’.

    Type:

    str

    js_view_class: str = 'RB.AddGeneralCommentActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    template_name: str = 'actions/detailed_menuitem_action.html'[source]¶

    The name of the template to use when rendering.

    Type:

    str

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class ShipItAction[source]¶

    Bases: BaseAction

    Action to mark a review request as “Ship It”.

    New in version 6.0.

    action_id: Optional[str] = 'ship-it'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    parent_id: Optional[str] = 'review-menu'[source]¶

    The ID of the parent menu action, if available.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    attachment: str = 'unified-banner'[source]¶

    The attachment point for the action.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Ship it!'[source]¶

    The user-visible label.

    Type:

    str

    description = ["You're happy with what you're seeing, and would like to approve it.", 'If you want to leave a comment with this, choose "Create a new review" above.'][source]¶
    icon_class: Optional[str] = 'rb-icon rb-icon-shipit'[source]¶

    A class name to use for an icon.

    If specified, this should be the entire class to apply to a <span> element to display an icon. For example, ‘fa fa-rss’.

    Type:

    str

    js_view_class: str = 'RB.ShipItActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    template_name: str = 'actions/detailed_menuitem_action.html'[source]¶

    The name of the template to use when rendering.

    Type:

    str

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class LegacyAddGeneralCommentAction[source]¶

    Bases: BaseAction

    The action for adding a general comment.

    New in version 6.0.

    action_id: Optional[str] = 'legacy-add-general-comment'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Add General Comment'[source]¶

    The user-visible label.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    should_render(*, context: Context) → bool[source]¶

    Return whether this action should render.

    This differs from hidden in that hidden actions still render but are hidden by CSS, whereas if this returns False the action will not be included in the DOM at all.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class LegacyEditReviewAction[source]¶

    Bases: BaseAction

    The old-style “Edit Review” action.

    This exists within the review request actions area, and will be supplanted by the new action in the Review menu in the unified banner.

    New in version 6.0.

    action_id: Optional[str] = 'legacy-edit-review'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Review'[source]¶

    The user-visible label.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    should_render(*, context: Context) → bool[source]¶

    Return whether this action should render.

    This differs from hidden in that hidden actions still render but are hidden by CSS, whereas if this returns False the action will not be included in the DOM at all.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class LegacyShipItAction[source]¶

    Bases: BaseAction

    The old-style “Ship It” action.

    This exists within the review request actions area, and will be supplanted by the new action in the Review menu in the unified banner.

    New in version 6.0.

    action_id: Optional[str] = 'legacy-ship-it'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Ship It!'[source]¶

    The user-visible label.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    should_render(*, context: Context) → bool[source]¶

    Return whether this action should render.

    This differs from hidden in that hidden actions still render but are hidden by CSS, whereas if this returns False the action will not be included in the DOM at all.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class UpdateMenuAction[source]¶

    Bases: BaseMenuAction

    A menu for updating the review request.

    New in version 6.0.

    action_id: Optional[str] = 'update-menu'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Update'[source]¶

    The user-visible label.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    should_render(*, context: Context) → bool[source]¶

    Return whether this action should render.

    This differs from hidden in that hidden actions still render but are hidden by CSS, whereas if this returns False the action will not be included in the DOM at all.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'children': 'List[str]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class UploadDiffAction[source]¶

    Bases: BaseAction

    The action to update or upload a diff.

    New in version 6.0.

    action_id: Optional[str] = 'upload-diff'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    parent_id: Optional[str] = 'update-menu'[source]¶

    The ID of the parent menu action, if available.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    js_view_class: str = 'RB.UpdateDiffActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    get_label(*, context: Context) → StrOrPromise[source]¶

    Return the label for the action.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    The label to use for the action.

    Return type:

    str

    should_render(*, context: Context) → bool[source]¶

    Return whether this action should render.

    This differs from hidden in that hidden actions still render but are hidden by CSS, whereas if this returns False the action will not be included in the DOM at all.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class UploadFileAction[source]¶

    Bases: BaseAction

    The action to upload a new file attachment.

    New in version 6.0.

    action_id: Optional[str] = 'upload-file'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    parent_id: Optional[str] = 'update-menu'[source]¶

    The ID of the parent menu action, if available.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Add File'[source]¶

    The user-visible label.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    js_view_class: str = 'RB.AddFileActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    should_render(*, context: Context) → bool[source]¶

    Return whether this action should render.

    This differs from hidden in that hidden actions still render but are hidden by CSS, whereas if this returns False the action will not be included in the DOM at all.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class StarAction[source]¶

    Bases: BaseAction

    The action to star a review request.

    New in version 6.0.

    action_id: Optional[str] = 'star-review-request'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    attachment: str = 'review-request-left'[source]¶

    The attachment point for the action.

    Type:

    str

    label: Optional[_StrOrPromise] = ''[source]¶

    The user-visible label.

    Type:

    str

    template_name: str = 'reviews/star_action.html'[source]¶

    The name of the template to use when rendering.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    should_render(*, context: Context) → bool[source]¶

    Return whether this action should render.

    This differs from hidden in that hidden actions still render but are hidden by CSS, whereas if this returns False the action will not be included in the DOM at all.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class ArchiveMenuAction[source]¶

    Bases: BaseMenuAction

    A menu for managing the visibility state of the review request.

    New in version 6.0.

    action_id: Optional[str] = 'archive-menu'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    attachment: str = 'review-request-left'[source]¶

    The attachment point for the action.

    Type:

    str

    label: Optional[_StrOrPromise] = ''[source]¶

    The user-visible label.

    Type:

    str

    template_name: str = 'reviews/archive_menu_action.html'[source]¶

    The name of the template to use when rendering.

    Type:

    str

    js_view_class: str = 'RB.ArchiveMenuActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    should_render(*, context: Context) → bool[source]¶

    Return whether this action should render.

    This differs from hidden in that hidden actions still render but are hidden by CSS, whereas if this returns False the action will not be included in the DOM at all.

    Parameters:

    context (django.template.Context) – The current rendering context.

    Returns:

    True if the action should render.

    Return type:

    bool

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'children': 'List[str]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class ArchiveAction[source]¶

    Bases: BaseAction

    An action for archiving the review request.

    New in version 6.0.

    action_id: Optional[str] = 'archive'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    parent_id: Optional[str] = 'archive-menu'[source]¶

    The ID of the parent menu action, if available.

    Type:

    str

    attachment: str = 'review-request-left'[source]¶

    The attachment point for the action.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    js_view_class: str = 'RB.ArchiveActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Toggle Archived'[source]¶

    The user-visible label.

    Type:

    str

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class MuteAction[source]¶

    Bases: BaseAction

    An action for muting the review request.

    New in version 6.0.

    action_id: Optional[str] = 'mute'[source]¶

    The internal ID of the action.

    This must be unique.

    Type:

    str

    parent_id: Optional[str] = 'archive-menu'[source]¶

    The ID of the parent menu action, if available.

    Type:

    str

    attachment: str = 'review-request-left'[source]¶

    The attachment point for the action.

    Type:

    str

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    js_view_class: str = 'RB.MuteActionView'[source]¶

    The class to instantiate for the JavaScript view.

    Type:

    str

    label: Optional[_StrOrPromise] = 'Toggle Muted'[source]¶

    The user-visible label.

    Type:

    str

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class BaseReviewRequestAction[source]¶

    Bases: BaseAction

    A base class for an action that can be applied to a review request.

    Creating an action requires subclassing BaseReviewRequestAction and overriding any fields/methods as desired. Different instances of the same subclass can also override the class fields with their own instance fields.

    Example

    class UsedOnceAction(BaseReviewRequestAction):
        action_id = 'once'
        label = 'This is used once.'
    
    class UsedMultipleAction(BaseReviewRequestAction):
        def __init__(self, action_id, label):
            super().__init__()
    
            self.action_id = 'repeat-' + action_id
            self.label = 'This is used multiple times,'
    

    Note

    Since the same action will be rendered for multiple different users in a multithreaded environment, the action state should not be modified after initialization. If we want different action attributes at runtime, then we can override one of the getter methods (such as get_label()), which by default will simply return the original attribute from initialization.

    Deprecated since version 6.0: New code should be written using reviewboard.actions.base.BaseAction. This class will be removed in 7.0.

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    __init__() → None[source]¶

    Initialize this action.

    By default, actions are top-level and have no children.

    property max_depth: int[source]¶

    Lazily compute the max depth of any action contained by this action.

    Top-level actions have a depth of zero, and child actions have a depth that is one more than their parent action’s depth.

    Algorithmically, the notion of max depth is equivalent to the notion of height in the context of trees (from graph theory). We decided to use this term instead so as not to confuse it with the dimensional height of a UI element.

    Returns:

    The max depth of any action contained by this action.

    Return type:

    int

    reset_max_depth() → None[source]¶

    Reset the max_depth of this action and all its ancestors to zero.

    get_extra_context(*, request: HttpRequest, context: Context) → dict[source]¶

    Return extra template context for the action.

    Parameters:
    • request (django.http.HttpRequest) – The HTTP request from the client.

    • context (django.template.Context) – The current rendering context.

    Returns:

    Extra context to use when rendering the action’s template.

    Return type:

    dict

    copy_to_dict(context: Context) → dict[source]¶

    Copy this action instance to a dictionary.

    This is a legacy implementation left to maintain compatibility with custom templates.

    register(parent: Optional[BaseReviewRequestMenuAction] = None) → None[source]¶

    Register this review request action instance.

    Note

    Newly registered top-level actions are appended to the left of the other previously registered top-level actions. So if we intend to register a collection of top-level actions in a certain order, then we likely want to iterate through the actions in reverse.

    Parameters:

    parent (BaseReviewRequestMenuAction, optional) – The parent action instance of this action instance.

    Raises:
    • KeyError – A second registration is attempted (action IDs must be unique across all types of actions and menu actions, at any depth).

    • DepthLimitExceededError – The maximum depth limit is exceeded.

    unregister() → None[source]¶

    Unregister this review request action instance.

    Note

    This method can mutate its parent’s child actions. So if we are iteratively unregistering a parent’s child actions, then we should consider first making a clone of the list of children.

    Raises:

    KeyError – An unregistration is attempted before it’s registered.

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    class BaseReviewRequestMenuAction(child_actions: Optional[List[BaseReviewRequestAction]] = None)[source]¶

    Bases: BaseMenuAction

    A base class for an action with a dropdown menu.

    Deprecated since version 6.0: New code should be written using reviewboard.actions.base.BaseMenuAction. This class will be removed in 7.0.

    apply_to: Optional[List[str]] = ['view-diff', 'view-interdiff', 'view-diff-revision', 'file-attachment', 'screenshot', 'view-diff', 'view-interdiff', 'view-diff-revision', 'review-request-detail'][source]¶

    A list of URLs to apply to.

    If this is None, the action will be loaded on all pages. Otherwise, it will be limited to the URLs listed here.

    Type:

    list of str

    __init__(child_actions: Optional[List[BaseReviewRequestAction]] = None) → None[source]¶

    Initialize this menu action.

    Parameters:

    child_actions (list of BaseReviewRequestAction, optional) – The list of child actions to be contained by this menu action.

    Raises:
    • KeyError – A second registration is attempted (action IDs must be unique across all types of actions and menu actions, at any depth).

    • DepthLimitExceededError – The maximum depth limit is exceeded.

    copy_to_dict(context: Context) → dict[source]¶

    Copy this menu action instance to a dictionary.

    This is a legacy implementation left to maintain compatibility with custom templates.

    Parameters:

    context (django.template.Context) – The collection of key-value pairs from the template.

    Returns:

    The corresponding dictionary.

    Return type:

    dict

    get_extra_context(*, request: HttpRequest, context: Context) → dict[source]¶

    Return extra template context for the action.

    Parameters:
    • request (django.http.HttpRequest) – The HTTP request from the client.

    • context (django.template.Context) – The current rendering context.

    Returns:

    Extra context to use when rendering the action’s template.

    Return type:

    dict

    property max_depth: int[source]¶

    Lazily compute the max depth of any action contained by this action.

    Returns:

    The max depth of any action contained by this action.

    Return type:

    int

    register(parent: Optional[BaseReviewRequestMenuAction] = None) → None[source]¶

    Register this review request action instance.

    Note

    Newly registered top-level actions are appended to the left of the other previously registered top-level actions. So if we intend to register a collection of top-level actions in a certain order, then we likely want to iterate through the actions in reverse.

    Parameters:

    parent (BaseReviewRequestMenuAction, optional) – The parent action instance of this action instance.

    Raises:
    • KeyError – A second registration is attempted (action IDs must be unique across all types of actions and menu actions, at any depth).

    • DepthLimitExceededError – The maximum depth limit is exceeded.

    unregister() → None[source]¶

    Unregister this review request action instance.

    This menu action recursively unregisters its child action instances.

    Raises:

    KeyError – An unregistration is attempted before it’s registered.

    __annotations__ = {'action_id': 'Optional[str]', 'apply_to': 'Optional[List[str]]', 'attachment': 'str', 'child_actions': 'List[BaseAction]', 'children': 'List[str]', 'icon_class': 'Optional[str]', 'js_model_class': 'str', 'js_template_name': 'str', 'js_view_class': 'str', 'label': 'Optional[_StrOrPromise]', 'parent_action': 'Optional[BaseMenuAction]', 'parent_id': 'Optional[str]', 'template_name': 'str', 'url': 'str', 'url_name': 'Optional[str]', 'visible': 'bool'}¶
    register_actions(actions: List[Union[BaseReviewRequestAction, BaseReviewRequestMenuAction]], parent_id: Optional[str] = None) → None[source]¶

    Register the given actions as children of the corresponding parent.

    If no parent_id is given, then the actions are assumed to be top-level.

    Deprecated since version 6.0: Users should switch to reviewboard.actions.actions_registry. This method will be removed in Review Board 8.

    Parameters:
    • actions (iterable of BaseReviewRequestAction) – The collection of action instances to be registered.

    • parent_id (unicode, optional) – The action ID of the parent of each action instance to be registered.

    Raises:
    • KeyError – The parent action cannot be found or a second registration is attempted (action IDs must be unique across all types of actions and menu actions, at any depth).

    • DepthLimitExceededError – The maximum depth limit is exceeded.

    unregister_actions(action_ids: Iterable[str]) → None[source]¶

    Unregister each of the actions corresponding to the given IDs.

    Deprecated since version 6.0: Users should switch to reviewboard.actions.actions_registry. This method will be removed in Review Board 8.

    Parameters:

    action_ids (iterable of unicode) – The collection of action IDs corresponding to the actions to be removed.

    Raises:

    KeyError – An unregistration is attempted before it’s registered.

    clear_all_actions() → None[source]¶

    Clear all registered actions.

    This method is really only intended to be used by unit tests. We might be able to remove this hack once we convert to djblets.registries.

    Deprecated since version 6.0: Users should switch to reviewboard.actions.actions_registry. This method will be removed in Review Board 8.

    Warning

    This will clear all actions, even if they were registered in separate extensions.

    Keep up with the latest Review Board releases, security updates, and helpful information.

    About
    News
    Demo
    RBCommons Hosting
    Integrations
    Happy Users
    Support Options
    Documentation
    FAQ
    User Manual
    RBTools
    Administration Guide
    Power Pack
    Release Notes
    Downloads
    Review Board
    RBTools
    Djblets
    Power Pack
    Package Store
    PGP Signatures
    Contributing
    Bug Tracker
    Submit Patches
    Development Setup
    Wiki
    Follow Us
    Mailing Lists
    Reddit
    Twitter
    Mastodon
    Facebook
    YouTube

    Copyright © 2006-2025 Beanbag, Inc. All rights reserved.

    Terms of Service — Privacy Policy — AI Ethics Policy — Branding

    On this page

    • [Top]
    • CloseMenuAction
      • CloseMenuAction.action_id
      • CloseMenuAction.label
      • CloseMenuAction.apply_to
      • CloseMenuAction.should_render()
      • CloseMenuAction.__annotations__
    • CloseCompletedAction
      • CloseCompletedAction.action_id
      • CloseCompletedAction.parent_id
      • CloseCompletedAction.label
      • CloseCompletedAction.apply_to
      • CloseCompletedAction.js_view_class
      • CloseCompletedAction.should_render()
      • CloseCompletedAction.__annotations__
    • CloseDiscardedAction
      • CloseDiscardedAction.action_id
      • CloseDiscardedAction.parent_id
      • CloseDiscardedAction.label
      • CloseDiscardedAction.apply_to
      • CloseDiscardedAction.js_view_class
      • CloseDiscardedAction.__annotations__
    • DeleteAction
      • DeleteAction.action_id
      • DeleteAction.parent_id
      • DeleteAction.label
      • DeleteAction.apply_to
      • DeleteAction.js_view_class
      • DeleteAction.should_render()
      • DeleteAction.__annotations__
    • DownloadDiffAction
      • DownloadDiffAction.action_id
      • DownloadDiffAction.label
      • DownloadDiffAction.apply_to
      • DownloadDiffAction.get_url()
      • DownloadDiffAction.get_visible()
      • DownloadDiffAction.should_render()
      • DownloadDiffAction.__annotations__
    • ReviewMenuAction
      • ReviewMenuAction.action_id
      • ReviewMenuAction.apply_to
      • ReviewMenuAction.attachment
      • ReviewMenuAction.label
      • ReviewMenuAction.icon_class
      • ReviewMenuAction.js_view_class
      • ReviewMenuAction.should_render()
      • ReviewMenuAction.__annotations__
    • CreateReviewAction
      • CreateReviewAction.action_id
      • CreateReviewAction.parent_id
      • CreateReviewAction.apply_to
      • CreateReviewAction.attachment
      • CreateReviewAction.label
      • CreateReviewAction.description
      • CreateReviewAction.icon_class
      • CreateReviewAction.js_view_class
      • CreateReviewAction.template_name
      • CreateReviewAction.__annotations__
    • EditReviewAction
      • EditReviewAction.action_id
      • EditReviewAction.parent_id
      • EditReviewAction.apply_to
      • EditReviewAction.attachment
      • EditReviewAction.label
      • EditReviewAction.description
      • EditReviewAction.icon_class
      • EditReviewAction.js_view_class
      • EditReviewAction.template_name
      • EditReviewAction.__annotations__
    • AddGeneralCommentAction
      • AddGeneralCommentAction.action_id
      • AddGeneralCommentAction.parent_id
      • AddGeneralCommentAction.apply_to
      • AddGeneralCommentAction.attachment
      • AddGeneralCommentAction.label
      • AddGeneralCommentAction.description
      • AddGeneralCommentAction.icon_class
      • AddGeneralCommentAction.js_view_class
      • AddGeneralCommentAction.template_name
      • AddGeneralCommentAction.__annotations__
    • ShipItAction
      • ShipItAction.action_id
      • ShipItAction.parent_id
      • ShipItAction.apply_to
      • ShipItAction.attachment
      • ShipItAction.label
      • ShipItAction.description
      • ShipItAction.icon_class
      • ShipItAction.js_view_class
      • ShipItAction.template_name
      • ShipItAction.__annotations__
    • LegacyAddGeneralCommentAction
      • LegacyAddGeneralCommentAction.action_id
      • LegacyAddGeneralCommentAction.label
      • LegacyAddGeneralCommentAction.apply_to
      • LegacyAddGeneralCommentAction.should_render()
      • LegacyAddGeneralCommentAction.__annotations__
    • LegacyEditReviewAction
      • LegacyEditReviewAction.action_id
      • LegacyEditReviewAction.label
      • LegacyEditReviewAction.apply_to
      • LegacyEditReviewAction.should_render()
      • LegacyEditReviewAction.__annotations__
    • LegacyShipItAction
      • LegacyShipItAction.action_id
      • LegacyShipItAction.label
      • LegacyShipItAction.apply_to
      • LegacyShipItAction.should_render()
      • LegacyShipItAction.__annotations__
    • UpdateMenuAction
      • UpdateMenuAction.action_id
      • UpdateMenuAction.label
      • UpdateMenuAction.apply_to
      • UpdateMenuAction.should_render()
      • UpdateMenuAction.__annotations__
    • UploadDiffAction
      • UploadDiffAction.action_id
      • UploadDiffAction.parent_id
      • UploadDiffAction.apply_to
      • UploadDiffAction.js_view_class
      • UploadDiffAction.get_label()
      • UploadDiffAction.should_render()
      • UploadDiffAction.__annotations__
    • UploadFileAction
      • UploadFileAction.action_id
      • UploadFileAction.parent_id
      • UploadFileAction.label
      • UploadFileAction.apply_to
      • UploadFileAction.js_view_class
      • UploadFileAction.should_render()
      • UploadFileAction.__annotations__
    • StarAction
      • StarAction.action_id
      • StarAction.attachment
      • StarAction.label
      • StarAction.template_name
      • StarAction.apply_to
      • StarAction.should_render()
      • StarAction.__annotations__
    • ArchiveMenuAction
      • ArchiveMenuAction.action_id
      • ArchiveMenuAction.attachment
      • ArchiveMenuAction.label
      • ArchiveMenuAction.template_name
      • ArchiveMenuAction.js_view_class
      • ArchiveMenuAction.apply_to
      • ArchiveMenuAction.should_render()
      • ArchiveMenuAction.__annotations__
    • ArchiveAction
      • ArchiveAction.action_id
      • ArchiveAction.parent_id
      • ArchiveAction.attachment
      • ArchiveAction.apply_to
      • ArchiveAction.js_view_class
      • ArchiveAction.label
      • ArchiveAction.__annotations__
    • MuteAction
      • MuteAction.action_id
      • MuteAction.parent_id
      • MuteAction.attachment
      • MuteAction.apply_to
      • MuteAction.js_view_class
      • MuteAction.label
      • MuteAction.__annotations__
    • BaseReviewRequestAction
      • BaseReviewRequestAction.apply_to
      • BaseReviewRequestAction.__init__()
      • BaseReviewRequestAction.max_depth
      • BaseReviewRequestAction.reset_max_depth()
      • BaseReviewRequestAction.get_extra_context()
      • BaseReviewRequestAction.copy_to_dict()
      • BaseReviewRequestAction.register()
      • BaseReviewRequestAction.unregister()
      • BaseReviewRequestAction.__annotations__
    • BaseReviewRequestMenuAction
      • BaseReviewRequestMenuAction.apply_to
      • BaseReviewRequestMenuAction.__init__()
      • BaseReviewRequestMenuAction.copy_to_dict()
      • BaseReviewRequestMenuAction.get_extra_context()
      • BaseReviewRequestMenuAction.max_depth
      • BaseReviewRequestMenuAction.register()
      • BaseReviewRequestMenuAction.unregister()
      • BaseReviewRequestMenuAction.__annotations__
    • register_actions()
    • unregister_actions()
    • clear_all_actions()