• 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.datagrids.grids
  • 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.datagrids.grids¶

    Datagrids for the Dashboard and other pages.

    class ShowClosedReviewRequestsMixin[source]¶

    Bases: object

    A mixin for showing or hiding closed review requests.

    load_extra_state(profile, allow_hide_closed=True)[source]¶

    Load extra state for the datagrid.

    class DataGridJSMixin(*args, **kwargs)[source]¶

    Bases: object

    Mixin that provides enhanced JavaScript support for datagrids.

    This contains additional information on the JavaScript views/models to load for the page, allowing for enhanced functionality in datagrids.

    css_bundle_names = [][source]¶

    A list of extra CSS static bundles to load on the page.

    js_bundle_names = [][source]¶

    A list of extra JavaScript static bundles to load on the page.

    js_model_class = 'RB.DatagridPage'[source]¶

    The JavaScript Model to use for the page state.

    js_view_class = 'RB.DatagridPageView'[source]¶

    The JavaScript View to use for the page rendering.

    periodic_reload = False[source]¶

    Whether or not to periodically reload the contents of the datagrid.

    extra_js_model_data = None[source]¶

    Extra data to pass to the JavaScript Model.

    __init__(*args, **kwargs)[source]¶

    Initialize the mixin.

    This will pull out the Local Site, which is common to all datagrids, and store it for later use and for JavaScript attribute population.

    Parameters:
    • *args (tuple) – Positional arguments passed to the datagrid.

    • **kwargs (dict) – Keyword arguments passed to the datagrid.

    get_js_model_attrs()[source]¶

    Return attributes for the JavaScript model.

    These will be passed to the model specified in js_model_class during construction.

    Subclasses can override this to provide additional data.

    Returns:

    Attributes to provide to the JavaScript model.

    Return type:

    dict

    get_js_model_options()[source]¶

    Return options for the JavaScript model.

    These will be passed to the model specified in js_model_class during construction.

    Subclasses can override this to provide additional data.

    Returns:

    Options to provide to the JavaScript model.

    Return type:

    dict

    get_js_view_options()[source]¶

    Return options for the JavaScript view.

    These will be passed to the view specified in js_view_class during construction.

    Subclasses can override this to provide additional data.

    Returns:

    Options to provide to the JavaScript view.

    Return type:

    dict

    class DataGrid(*args, **kwargs)[source]¶

    Bases: DataGridJSMixin, DataGrid

    Base class for a datagrid in Review Board.

    This contains additional information on JavaScript views/models to load for the page.

    __annotations__ = {}¶
    class AlphanumericDataGrid(*args, **kwargs)[source]¶

    Bases: DataGridJSMixin, AlphanumericDataGrid

    Base class for an alphanumeric datagrid in Review Board.

    This contains additional information on JavaScript views/models to load for the page.

    __annotations__ = {}¶
    class ReviewRequestDataGrid(*args, **kwargs)[source]¶

    Bases: ShowClosedReviewRequestsMixin, DataGrid

    A datagrid that displays a list of review requests.

    This datagrid accepts the show_closed parameter in the URL, allowing submitted review requests to be filtered out or displayed.

    new_updates = <reviewboard.datagrids.columns.NewUpdatesColumn object>[source]¶
    my_comments = <reviewboard.datagrids.columns.MyCommentsColumn object>[source]¶
    star = <reviewboard.datagrids.columns.ReviewRequestStarColumn object>[source]¶
    ship_it = <reviewboard.datagrids.columns.ShipItColumn object>[source]¶
    summary = <reviewboard.datagrids.columns.SummaryColumn object>[source]¶
    submitter = <reviewboard.datagrids.columns.UsernameColumn object>[source]¶
    branch = <djblets.datagrid.grids.Column object>[source]¶
    bugs_closed = <reviewboard.datagrids.columns.BugsColumn object>[source]¶
    repository = <reviewboard.datagrids.columns.RepositoryColumn object>[source]¶
    time_added = <djblets.datagrid.grids.DateTimeColumn object>[source]¶
    last_updated = <djblets.datagrid.grids.DateTimeColumn object>[source]¶
    diff_updated = <reviewboard.datagrids.columns.DiffUpdatedColumn object>[source]¶
    time_added_since = <reviewboard.datagrids.columns.DateTimeSinceColumn object>[source]¶
    last_updated_since = <reviewboard.datagrids.columns.DateTimeSinceColumn object>[source]¶
    diff_updated_since = <reviewboard.datagrids.columns.DiffUpdatedSinceColumn object>[source]¶
    diff_size = <reviewboard.datagrids.columns.DiffSizeColumn object>[source]¶
    review_count = <reviewboard.datagrids.columns.ReviewCountColumn object>[source]¶
    target_groups = <reviewboard.datagrids.columns.GroupsColumn object>[source]¶
    target_people = <reviewboard.datagrids.columns.PeopleColumn object>[source]¶
    to_me = <reviewboard.datagrids.columns.ToMeColumn object>[source]¶
    review_id = <reviewboard.datagrids.columns.ReviewRequestIDColumn object>[source]¶
    status_query_field = 'status'[source]¶
    site_query_field = 'local_site'[source]¶
    __init__(*args, **kwargs) → None[source]¶

    Initialize the datagrid.

    Parameters:
    • *args (tuple) – Positional arguments to pass to the parent.

    • **kwargs (dict) – Keyword arguments to pass to the parent.

    load_extra_state(profile, allow_hide_closed=True)[source]¶

    Load extra state for the datagrid.

    post_process_queryset(queryset: QuerySet[ReviewRequest]) → QuerySet[ReviewRequest][source]¶

    Add additional data to the queryset.

    Parameters:

    queryset (django.db.models.QuerySet) – The queryset to post-process.

    Returns:

    The resulting queryset.

    Return type:

    django.db.models.QuerySet

    link_to_object(state, obj, value)[source]¶

    Return a link to the given object.

    __annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶
    class ReviewDataGrid(*args, **kwargs)[source]¶

    Bases: ShowClosedReviewRequestsMixin, DataGrid

    A datagrid that displays a list of reviews.

    This datagrid accepts the show_closed parameter in the URL, allowing submitted review requests to be filtered out or displayed.

    timestamp = <djblets.datagrid.grids.DateTimeColumn object>[source]¶
    submitter = <reviewboard.datagrids.columns.UsernameColumn object>[source]¶
    review_summary = <reviewboard.datagrids.columns.ReviewSummaryColumn object>[source]¶
    status_query_field = 'review_request__status'[source]¶
    site_query_field = 'review_request__local_site'[source]¶
    __init__(*args, **kwargs)[source]¶

    Initialize the datagrid.

    post_process_queryset(queryset: QuerySet[Review]) → QuerySet[Review][source]¶

    Add additional data to the queryset.

    Parameters:

    queryset (django.db.models.QuerySet) – The queryset to post-process.

    Returns:

    The resulting queryset.

    Return type:

    django.db.models.QuerySet

    __annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶
    class DashboardDataGrid(*args, **kwargs)[source]¶

    Bases: DataGridSidebarMixin, ReviewRequestDataGrid

    Displays the dashboard.

    The dashboard is the main place where users see what review requests are out there that may need their attention.

    new_updates = <reviewboard.datagrids.columns.NewUpdatesColumn object>[source]¶
    my_comments = <reviewboard.datagrids.columns.MyCommentsColumn object>[source]¶
    selected = <reviewboard.datagrids.columns.ReviewRequestCheckboxColumn object>[source]¶
    sidebar = <reviewboard.datagrids.sidebar.Sidebar object>[source]¶
    js_model_class = 'RB.Dashboard'[source]¶

    The JavaScript Model to use for the page state.

    js_view_class = 'RB.DashboardView'[source]¶

    The JavaScript View to use for the page rendering.

    periodic_reload = True[source]¶

    Whether or not to periodically reload the contents of the datagrid.

    __init__(*args, **kwargs)[source]¶

    Initialize the datagrid.

    load_extra_state(profile: Profile) → List[str][source]¶

    Load extra state for the datagrid.

    Parameters:

    profile (reviewboard.accounts.models.Profile) – The profile containing state for customizing the dashboard.

    Returns:

    A list of profile fields that have changed.

    Return type:

    list of str

    __annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶
    class UsersDataGrid(request: HttpRequest, queryset: QuerySet[User] = <QuerySet [<User: admin>, <User: doc>, <User: dopey>, <User: grumpy>]>, title: StrOrPromise = 'All users', local_site: Optional[LocalSite] = None)[source]¶

    Bases: AlphanumericDataGrid

    A datagrid showing a list of users registered on Review Board.

    username = <reviewboard.datagrids.columns.UsernameColumn object>[source]¶
    fullname = <reviewboard.datagrids.columns.FullNameColumn object>[source]¶
    pending_count = <reviewboard.datagrids.columns.PendingCountColumn object>[source]¶
    __init__(request: HttpRequest, queryset: QuerySet[User] = <QuerySet [<User: admin>, <User: doc>, <User: dopey>, <User: grumpy>]>, title: StrOrPromise = 'All users', local_site: Optional[LocalSite] = None) → None[source]¶

    Initialize the datagrid.

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

    • queryset (django.db.models.QuerySet, optional) – The base queryset for this datagrid.

    • title (str, optional) – The title for this datagrid.

    • local_site (reviewboard.site.models.LocalSite, optional) – The Local Site being accessed.

    link_to_object(state, obj, value)[source]¶

    Return a link to the given object.

    load_extra_state(profile)[source]¶

    Load extra state for the datagrid.

    This handles hiding or showing inactive users.

    Parameters:

    profile (reviewboard.accounts.models.Profile) – The user profile which contains some basic configurable settings.

    Returns:

    Always returns False.

    Return type:

    bool

    post_process_queryset_for_data(queryset: QuerySet, **kwargs) → QuerySet[source]¶

    Add additional lookups for the datagrid’s queryset

    This will add any column-specific queries to the queryset, and then select-related the Local Sites so that operations that require the Local Site relation can be conducted without an additional query.

    New in version 5.0.7.

    Parameters:
    • queryset (django.db.models.query.QuerySet) – The queryset to augment.

    • **kwargs (dict) – Additional keyword arguments for future expansion.

    Returns:

    The resulting augmented QuerySet.

    Return type:

    django.db.models.query.QuerySet

    __annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'current_letter': 'str', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶
    class GroupDataGrid(request, title='All groups', *args, **kwargs)[source]¶

    Bases: DataGrid

    A datagrid showing a list of review groups accessible by the user.

    star = <reviewboard.datagrids.columns.ReviewGroupStarColumn object>[source]¶
    name = <djblets.datagrid.grids.Column object>[source]¶
    displayname = <djblets.datagrid.grids.Column object>[source]¶
    pending_count = <reviewboard.datagrids.columns.PendingCountColumn object>[source]¶
    member_count = <reviewboard.datagrids.columns.GroupMemberCountColumn object>[source]¶
    __init__(request, title='All groups', *args, **kwargs)[source]¶

    Initialize the datagrid.

    post_process_queryset_for_data(queryset: QuerySet, **kwargs) → QuerySet[source]¶

    Add additional lookups for the datagrid’s queryset

    This will add any column-specific queries to the queryset, and then select-related the Local Sites so that operations that require the Local Site relation can be conducted without an additional query.

    New in version 5.0.7.

    Parameters:
    • queryset (django.db.models.query.QuerySet) – The queryset to augment.

    • **kwargs (dict) – Additional keyword arguments for future expansion.

    Returns:

    The resulting augmented QuerySet.

    Return type:

    django.db.models.query.QuerySet

    static link_to_object(state, obj, value)[source]¶

    Return a link to the given object.

    __annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶
    class UserPageDataGridMixin[source]¶

    Bases: DataGridSidebarMixin

    An abstract class for data grids on the user page.

    This will display information about the user on the side.

    sidebar = <reviewboard.datagrids.sidebar.Sidebar object>[source]¶
    __annotations__ = {}¶
    class UserPageReviewRequestDataGrid(request, user, *args, **kwargs)[source]¶

    Bases: UserPageDataGridMixin, ReviewRequestDataGrid

    A data grid for the user page.

    This will show the review requests the user has out for review.

    tab_title = 'Review Requests'[source]¶
    __init__(request, user, *args, **kwargs)[source]¶

    Initialize the datagrid.

    __annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶
    class UserPageReviewsDataGrid(request, user, *args, **kwargs)[source]¶

    Bases: UserPageDataGridMixin, ReviewDataGrid

    A data grid for the user page.

    This will show reviews the user has made on other review requests.

    tab_title = 'Reviews'[source]¶
    __init__(request, user, *args, **kwargs)[source]¶

    Initialize the datagrid.

    __annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶

    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]
    • ShowClosedReviewRequestsMixin
      • ShowClosedReviewRequestsMixin.load_extra_state()
    • DataGridJSMixin
      • DataGridJSMixin.css_bundle_names
      • DataGridJSMixin.js_bundle_names
      • DataGridJSMixin.js_model_class
      • DataGridJSMixin.js_view_class
      • DataGridJSMixin.periodic_reload
      • DataGridJSMixin.extra_js_model_data
      • DataGridJSMixin.__init__()
      • DataGridJSMixin.get_js_model_attrs()
      • DataGridJSMixin.get_js_model_options()
      • DataGridJSMixin.get_js_view_options()
    • DataGrid
      • DataGrid.__annotations__
    • AlphanumericDataGrid
      • AlphanumericDataGrid.__annotations__
    • ReviewRequestDataGrid
      • ReviewRequestDataGrid.new_updates
      • ReviewRequestDataGrid.my_comments
      • ReviewRequestDataGrid.star
      • ReviewRequestDataGrid.ship_it
      • ReviewRequestDataGrid.summary
      • ReviewRequestDataGrid.submitter
      • ReviewRequestDataGrid.branch
      • ReviewRequestDataGrid.bugs_closed
      • ReviewRequestDataGrid.repository
      • ReviewRequestDataGrid.time_added
      • ReviewRequestDataGrid.last_updated
      • ReviewRequestDataGrid.diff_updated
      • ReviewRequestDataGrid.time_added_since
      • ReviewRequestDataGrid.last_updated_since
      • ReviewRequestDataGrid.diff_updated_since
      • ReviewRequestDataGrid.diff_size
      • ReviewRequestDataGrid.review_count
      • ReviewRequestDataGrid.target_groups
      • ReviewRequestDataGrid.target_people
      • ReviewRequestDataGrid.to_me
      • ReviewRequestDataGrid.review_id
      • ReviewRequestDataGrid.status_query_field
      • ReviewRequestDataGrid.site_query_field
      • ReviewRequestDataGrid.__init__()
      • ReviewRequestDataGrid.load_extra_state()
      • ReviewRequestDataGrid.post_process_queryset()
      • ReviewRequestDataGrid.link_to_object()
      • ReviewRequestDataGrid.__annotations__
    • ReviewDataGrid
      • ReviewDataGrid.timestamp
      • ReviewDataGrid.submitter
      • ReviewDataGrid.review_summary
      • ReviewDataGrid.status_query_field
      • ReviewDataGrid.site_query_field
      • ReviewDataGrid.__init__()
      • ReviewDataGrid.post_process_queryset()
      • ReviewDataGrid.__annotations__
    • DashboardDataGrid
      • DashboardDataGrid.new_updates
      • DashboardDataGrid.my_comments
      • DashboardDataGrid.selected
      • DashboardDataGrid.sidebar
      • DashboardDataGrid.js_model_class
      • DashboardDataGrid.js_view_class
      • DashboardDataGrid.periodic_reload
      • DashboardDataGrid.__init__()
      • DashboardDataGrid.load_extra_state()
      • DashboardDataGrid.__annotations__
    • UsersDataGrid
      • UsersDataGrid.username
      • UsersDataGrid.fullname
      • UsersDataGrid.pending_count
      • UsersDataGrid.__init__()
      • UsersDataGrid.link_to_object()
      • UsersDataGrid.load_extra_state()
      • UsersDataGrid.post_process_queryset_for_data()
      • UsersDataGrid.__annotations__
    • GroupDataGrid
      • GroupDataGrid.star
      • GroupDataGrid.name
      • GroupDataGrid.displayname
      • GroupDataGrid.pending_count
      • GroupDataGrid.member_count
      • GroupDataGrid.__init__()
      • GroupDataGrid.post_process_queryset_for_data()
      • GroupDataGrid.link_to_object()
      • GroupDataGrid.__annotations__
    • UserPageDataGridMixin
      • UserPageDataGridMixin.sidebar
      • UserPageDataGridMixin.__annotations__
    • UserPageReviewRequestDataGrid
      • UserPageReviewRequestDataGrid.tab_title
      • UserPageReviewRequestDataGrid.__init__()
      • UserPageReviewRequestDataGrid.__annotations__
    • UserPageReviewsDataGrid
      • UserPageReviewsDataGrid.tab_title
      • UserPageReviewsDataGrid.__init__()
      • UserPageReviewsDataGrid.__annotations__