• 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 2.5
    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.extensions.hooks
  • Home
  • Users Guide
  • Getting Started
  • Introduction
  • What is Code Review?
  • General Workflow
  • 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
  • Issue Tracking
  • Review Draft Banner
  • Reviewing Diffs
  • Reviewing File Attachments
  • Reviewing Images
  • Reviewing Markdown Files
  • Reviewing Text Files
  • Creating and Editing Reviews
  • Publishing Reviews
  • Approving Changes (Ship It!)
  • Replying to Comments
  • Searching
  • Quick Search
  • Full-Text Search
  • Using Markdown
  • Administration Guide
  • Installation
  • Installing on Linux
  • Installing on Mac OS X Server
  • Installing on Windows
  • Installing Development Releases
  • Creating a Review Board Site
  • Upgrading
  • Upgrading Review Board
  • Upgrading Sites
  • Optimization
  • General Optimization Tips
  • Optimizing Memcached
  • Optimizing MySQL
  • Administration UI
  • Overview of the Administration UI
  • Administrator Dashboard
  • Database Management
  • Configuration
  • Site Settings
  • General Settings
  • Authentication Settings
  • E-Mail Settings
  • Diff Viewer Settings
  • Logging Settings
  • SSH Settings
  • File Storage Settings
  • Access Control
  • E-Mail
  • Default Reviewers
  • Permission Groups
  • Repositories
  • Bazaar Repositories
  • ClearCase Repositories
  • CVS Repositories
  • Git Repositories
  • Mercurial Repositories
  • Perforce Repositories
  • Subversion Repositories
  • Assembla Repositories
  • Beanstalk Repositories
  • Bitbucket Repositories
  • Codebase HQ Repositories
  • Fedora Hosted Repositories
  • GitHub Repositories
  • GitHub Enterprise Repositories
  • GitLab Repositories
  • Gitorious Repositories
  • SourceForge Repositories
  • Unfuddle STACK Repositories
  • VisualStudio.com Repositories
  • Review Groups
  • Users
  • WebHooks
  • Extensions
  • Site Maintenance
  • The rb-site Tool
  • Search Indexing
  • Advanced Management Commands
  • Web API Guide
  • Overview
  • Authenticating
  • Rich Text Fields and Types
  • 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
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info 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
  • 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
  • Watched List Resource
  • Validation List Resource
  • Validate Diff 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
  • File Diff List Resource
  • File Diff Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File 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
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info 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
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff 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 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
  • 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 File Diff List Resource
  • Draft File Diff Resource
  • Draft Diff Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File 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 Diff List Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot 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 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 Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply File Attachment 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 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 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 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 Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Search 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
  • 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
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request 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 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
  • 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
  • Glossary
  • REST API 2.0
  • Overview
  • Authenticating
  • API Token Policies
  • Rich Text Fields and Types
  • 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
  • Repository List Resource
  • Repository Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Request List Resource
  • Review Request Resource
  • Search Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Validation List Resource
  • Validate Diff 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
  • File Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff 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
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info 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
  • 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
  • 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 File Diff List Resource
  • Draft Diff Resource
  • Draft File Diff List Resource
  • Draft File Diff 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
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review File Attachment 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 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 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 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 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 Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Search 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
  • 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
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List 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 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
  • 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
  • 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
  • Extension Hooks
  • AccountPageFormsHook
  • AccountPagesHook
  • Action Hooks
  • AdminWidgetHook
  • AuthBackendHook
  • CommentDetailDisplayHook
  • DashboardColumnsHook
  • DashboardSidebarItemsHook
  • DataGridColumnsHook
  • EmailHook
  • ReviewRequestPublishedEmailHook
  • ReviewRequestClosedEmailHook
  • ReviewPublishedEmailHook
  • ReviewReplyPublishedEmailHook
  • FileAttachmentThumbnailHook
  • HostingServiceHook
  • NavigationBarHook
  • ReviewRequestApprovalHook
  • ReviewRequestFieldsHook
  • ReviewRequestFieldSetsHook
  • ReviewUIHook
  • SignalHook
  • TemplateHook
  • URLHook
  • UserPageSidebarItemsHook
  • WebAPICapabilitiesHook
  • JavaScript Extension Hooks
  • CommentDialogHook
  • ReviewDialogCommentHook
  • ReviewDialogHook
  • Review UI Integration
  • Writing Authentication Backends
  • Writing Legacy Authentication Backends
  • Extending the Web API
  • Module and Class References
  • reviewboard
  • reviewboard.rb_platform
  • reviewboard.signals
  • reviewboard.accounts.backends
  • reviewboard.accounts.decorators
  • reviewboard.accounts.errors
  • reviewboard.accounts.managers
  • reviewboard.accounts.models
  • reviewboard.accounts.pages
  • reviewboard.accounts.trophies
  • reviewboard.accounts.forms.auth
  • reviewboard.accounts.forms.pages
  • reviewboard.accounts.forms.registration
  • reviewboard.attachments.forms
  • reviewboard.attachments.managers
  • reviewboard.attachments.mimetypes
  • reviewboard.attachments.models
  • 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.myersdiff
  • reviewboard.diffviewer.opcode_generator
  • reviewboard.diffviewer.parser
  • reviewboard.diffviewer.processors
  • reviewboard.diffviewer.renderers
  • reviewboard.diffviewer.smdiff
  • reviewboard.extensions.base
  • reviewboard.extensions.hooks
  • reviewboard.extensions.packaging
  • reviewboard.extensions.testing
  • reviewboard.extensions.testing.testcases
  • reviewboard.hostingsvcs.errors
  • reviewboard.hostingsvcs.forms
  • reviewboard.hostingsvcs.hook_utils
  • reviewboard.hostingsvcs.repository
  • reviewboard.hostingsvcs.service
  • reviewboard.notifications.email
  • reviewboard.notifications.managers
  • reviewboard.notifications.models
  • reviewboard.reviews.chunk_generators
  • reviewboard.reviews.context
  • reviewboard.reviews.errors
  • reviewboard.reviews.fields
  • reviewboard.reviews.forms
  • reviewboard.reviews.managers
  • reviewboard.reviews.markdown_utils
  • reviewboard.reviews.models
  • reviewboard.reviews.signals
  • reviewboard.reviews.ui.base
  • reviewboard.reviews.ui.image
  • reviewboard.reviews.ui.text
  • reviewboard.scmtools.certs
  • reviewboard.scmtools.core
  • reviewboard.scmtools.crypto_utils
  • reviewboard.scmtools.errors
  • reviewboard.scmtools.forms
  • reviewboard.scmtools.managers
  • reviewboard.scmtools.models
  • reviewboard.scmtools.signals
  • reviewboard.search.indexes
  • reviewboard.site.decorators
  • reviewboard.site.models
  • reviewboard.site.signals
  • reviewboard.site.urlresolvers
  • reviewboard.site.validation
  • reviewboard.ssh.client
  • reviewboard.ssh.errors
  • reviewboard.ssh.policy
  • reviewboard.ssh.storage
  • reviewboard.ssh.utils
  • reviewboard.testing.testcase
  • reviewboard.webapi.base
  • reviewboard.webapi.decorators
  • reviewboard.webapi.errors
  • reviewboard.webapi.mixins
  • reviewboard.webapi.models
  • reviewboard.webapi.server_info
  • reviewboard
  • reviewboard.rb_platform
  • reviewboard.signals
  • reviewboard.accounts.backends
  • reviewboard.accounts.decorators
  • reviewboard.accounts.errors
  • reviewboard.accounts.managers
  • reviewboard.accounts.models
  • reviewboard.accounts.pages
  • reviewboard.accounts.trophies
  • reviewboard.accounts.forms.auth
  • reviewboard.accounts.forms.pages
  • reviewboard.accounts.forms.registration
  • reviewboard.attachments.forms
  • reviewboard.attachments.managers
  • reviewboard.attachments.mimetypes
  • reviewboard.attachments.models
  • 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.myersdiff
  • reviewboard.diffviewer.opcode_generator
  • reviewboard.diffviewer.parser
  • reviewboard.diffviewer.processors
  • reviewboard.diffviewer.renderers
  • reviewboard.diffviewer.smdiff
  • reviewboard.extensions.base
  • reviewboard.extensions.hooks
  • reviewboard.extensions.packaging
  • reviewboard.extensions.testing
  • reviewboard.extensions.testing.testcases
  • reviewboard.hostingsvcs.errors
  • reviewboard.hostingsvcs.forms
  • reviewboard.hostingsvcs.hook_utils
  • reviewboard.hostingsvcs.repository
  • reviewboard.hostingsvcs.service
  • reviewboard.notifications.email
  • reviewboard.notifications.managers
  • reviewboard.notifications.models
  • reviewboard.reviews.chunk_generators
  • reviewboard.reviews.context
  • reviewboard.reviews.errors
  • reviewboard.reviews.fields
  • reviewboard.reviews.forms
  • reviewboard.reviews.managers
  • reviewboard.reviews.markdown_utils
  • reviewboard.reviews.models
  • reviewboard.reviews.signals
  • reviewboard.reviews.ui.base
  • reviewboard.reviews.ui.image
  • reviewboard.reviews.ui.text
  • reviewboard.scmtools.certs
  • reviewboard.scmtools.core
  • reviewboard.scmtools.crypto_utils
  • reviewboard.scmtools.errors
  • reviewboard.scmtools.forms
  • reviewboard.scmtools.managers
  • reviewboard.scmtools.models
  • reviewboard.scmtools.signals
  • reviewboard.search.indexes
  • reviewboard.site.decorators
  • reviewboard.site.models
  • reviewboard.site.signals
  • reviewboard.site.urlresolvers
  • reviewboard.site.validation
  • reviewboard.ssh.client
  • reviewboard.ssh.errors
  • reviewboard.ssh.policy
  • reviewboard.ssh.storage
  • reviewboard.ssh.utils
  • reviewboard.testing.testcase
  • reviewboard.webapi.base
  • reviewboard.webapi.decorators
  • reviewboard.webapi.errors
  • reviewboard.webapi.mixins
  • reviewboard.webapi.models
  • reviewboard.webapi.server_info
  • Frequently Asked Questions
  • General Index
  • Python Module Index
  • Release Notes
  • This documentation covers Review Board 2.5. You can select a version above or view the latest documentation.

    reviewboard.extensions.hooks¶

    class AuthBackendHook(extension, backend_cls)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    A hook for registering an authentication backend.

    Authentication backends control user authentication, registration, and user lookup, and user data manipulation.

    This hook takes the class of an authentication backend that should be made available to the server.

    __init__(extension, backend_cls)[source]¶
    shutdown()[source]¶
    hooks = [][source]¶
    class AccountPagesHook(extension, page_classes)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    A hook for adding new pages to the My Account page.

    A page can contain one or more forms or even a custom template allowing for configuration of an extension.

    This takes a list of AccountPage classes as parameters, which it will later instantiate as necessary. Each page can be pre-populated with one or more custom AccountPageForm classes.

    __init__(extension, page_classes)[source]¶
    shutdown()[source]¶
    hooks = [][source]¶
    class AccountPageFormsHook(extension, page_id, form_classes)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    A hook for adding new forms to a page in the My Account page.

    This is used to add custom forms to a page in the My Account page. The form can be used to provide user-level customization of an extension, through a traditional form-based approach or even through custom JavaScript.

    This hook takes the ID of a registered page where the form should be placed. Review Board supplies the following built-in page IDs:

    • settings
    • authentication
    • profile
    • groups

    Any registered page ID can be provided, whether from this extension or another.

    Form classes can only be added to a single page.

    __init__(extension, page_id, form_classes)[source]¶
    shutdown()[source]¶
    hooks = [][source]¶
    class AdminWidgetHook(extension, widget_cls, primary=False)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    A hook for adding a new widget to the admin screen.

    By default the new widget is added as a small widget in the right column of the admin page. To instead add the new widget as a large widget in the center of the admin page, pass in True for primary.

    __init__(extension, widget_cls, primary=False)[source]¶
    shutdown()[source]¶
    hooks = [][source]¶
    class DataGridSidebarItemsHook(extension, datagrid, item_classes)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    A hook for adding items to the sidebar of a datagrid.

    Extensions can use this hook to plug new items into the sidebar of any datagrid supporting sidebars.

    The items can be any subclass of reviewboard.datagrids.sidebar.BaseSidebarItem, including the built-in reviewboard.datagrids.sidebar.BaseSidebarSection and built-in reviewboard.datagrids.sidebar.SidebarNavItem.

    __init__(extension, datagrid, item_classes)[source]¶
    shutdown()[source]¶
    hooks = [][source]¶
    class DashboardColumnsHook(extension, columns)[source]¶

    Bases: djblets.extensions.hooks.DataGridColumnsHook

    A hook for adding custom columns to the dashboard.

    Extensions can use this hook to provide one or more custom columns in the dashboard. These columns can be added by users, moved around, and even sorted, like other columns.

    Each value passed to columns must be an instance of djblets.datagrid.grids.Column.

    It also must have an id attribute set. This must be unique within the dashboard. It is recommended to use a vendor-specific prefix to the ID, in order to avoid conflicts.

    __init__(extension, columns)[source]¶
    class DashboardSidebarItemsHook(extension, item_classes)[source]¶

    Bases: reviewboard.extensions.hooks.DataGridSidebarItemsHook

    A hook for adding items to the sidebar of the dashboard.

    Extensions can use this hook to plug new items into the sidebar of the dashboard. These will appear below the built-in items.

    The items can be any subclass of reviewboard.datagrids.sidebar.BaseSidebarItem, including the built-in reviewboard.datagrids.sidebar.BaseSidebarSection and built-in reviewboard.datagrids.sidebar.SidebarNavItem.

    __init__(extension, item_classes)[source]¶
    class HostingServiceHook(extension, service_cls)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    A hook for registering a hosting service.

    __init__(extension, service_cls)[source]¶
    shutdown()[source]¶
    hooks = [][source]¶
    class NavigationBarHook(extension, entries={}, is_enabled_for=None, *args, **kwargs)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    A hook for adding entries to the main navigation bar.

    This takes a list of entries. Each entry represents something on the navigation bar, and is a dictionary with the following keys:

    • label: The label to display
    • url: The URL to point to.
    • url_name: The name of the URL to point to.

    Only one of url or url_name is required. url_name will take precedence.

    Optionally, a callable can be passed in for is_enabled_for, which takes a single argument (the user) and returns True or False, indicating whether the entries should be shown. If this is not passed in, the entries are always shown (including for anonymous users).

    If your hook needs to access the template context, it can override get_entries and return results from there.

    __init__(extension, entries={}, is_enabled_for=None, *args, **kwargs)[source]¶
    get_entries(context)[source]¶
    hooks = [][source]¶
    class ReviewRequestApprovalHook(extension)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    A hook for determining if a review request is approved.

    Extensions can use this to hook into the process for determining review request approval, which may impact any scripts integrating with Review Board to, for example, allow committing to a repository.

    is_approved(review_request, prev_approved, prev_failure)[source]¶

    Determines if the review request is approved.

    This function is provided with the review request and the previously calculated approved state (either from a prior hook, or from the base state of ship_it_count > 0 and issue_open_count == 0).

    If approved, this should return True. If unapproved, it should return a tuple with False and a string briefly explaining why it’s not approved. This may be displayed to the user.

    It generally should also take the previous approved state into consideration in this choice (such as returning False if the previous state is False). This is, however, fully up to the hook.

    The approval decision may be overridden by any following hooks.

    hooks = [][source]¶
    class ReviewRequestFieldSetsHook(extension, fieldsets)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    A hook for creating fieldsets on the side of the review request page.

    A fieldset contains one or more fields, and is mainly used to separate groups of fields from each other.

    This takes a list of fieldset classes as parameters, which it will later instantiate as necessary. Each fieldset can be pre-populated with one or more custom field classes.

    __init__(extension, fieldsets)[source]¶
    shutdown()[source]¶
    hooks = [][source]¶
    class ReviewRequestFieldsHook(extension, fieldset_id, fields)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    A hook for creating fields on the review request page.

    This is used to create custom fields on a review request page for requesting and storing data. A field can be editable, or it can be only for display purposes. See the classes in reviewboard.reviews.fields for more information and documentation.

    This hook takes the ID of a registered fieldset where the provided field classes should be added. Review Board supplies three built-in fieldset IDs:

    • main - The fieldset with Description and Testing Done.
    • info - The “Information” fieldset on the side.
    • reviewers - The “Reviewers” fieldset on the side.

    Any registered fieldset ID can be provided, whether from this extension or another.

    Field classes can only be added to a single fieldset.

    __init__(extension, fieldset_id, fields)[source]¶
    shutdown()[source]¶
    hooks = [][source]¶
    class WebAPICapabilitiesHook(extension, caps)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    This hook allows adding capabilities to the web API server info.

    Note that this does not add the functionality, but adds to the server info listing.

    __init__(extension, caps)[source]¶
    shutdown()[source]¶
    hooks = [][source]¶
    class CommentDetailDisplayHook(extension)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    This hook allows adding details to the display of comments.

    The hook can provide additional details to display for a comment in a review and e-mails.

    render_review_comment_detail(comment)[source]¶
    render_email_comment_detail(comment, is_html)[source]¶
    hooks = [][source]¶
    class ReviewUIHook(extension, review_uis)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    This hook allows integration of Extension-defined Review UIs.

    This accepts a list of Review UIs specified by the Extension and registers them when the hook is created. Likewise, it unregisters the same list of Review UIs when the Extension is disabled.

    __init__(extension, review_uis)[source]¶
    shutdown()[source]¶
    hooks = [][source]¶
    class FileAttachmentThumbnailHook(extension, mimetype_handlers)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    This hook allows custom thumbnails to be defined for file attachments.

    This accepts a list of Mimetype Handlers specified by the Extension that must:

    • Subclass reviewboard.attachments.mimetypes.MimetypeHandler
    • Define a list of file mimetypes it can handle in a class variable called supported_mimetypes
    • Define how to generate a thumbnail of that mimetype by overriding the instance function def get_thumbnail(self):

    These MimetypeHandlers are registered when the hook is created. Likewise, it unregisters the same list of MimetypeHandlers when the Extension is disabled.

    __init__(extension, mimetype_handlers)[source]¶
    shutdown()[source]¶
    hooks = [][source]¶
    class ActionHook(extension, actions=[], *args, **kwargs)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    A hook for adding actions to a review request.

    Actions are displayed somewhere on the action bar (alongside Reviews, Close, etc.) of the review request. The subclasses of ActionHook should be used to determine placement.

    The provided actions parameter must be a list of actions. Each action must be a dict with the following keys:

    • id: The ID of this action (optional).
    • image: The path to the image used for the icon (optional).
    • image_width: The width of the image (optional).
    • image_height: The height of the image (optional).
    • label: The label for the action.
    • url: The URI to invoke when the action is clicked.
      If you want to invoke a javascript action, this should be ‘#’, and you should use a selector on the id field to attach the handler (as opposed to a javascript: URL, which doesn’t work on all browsers).

    If your hook needs to access the template context, it can override get_actions and return results from there.

    __init__(extension, actions=[], *args, **kwargs)[source]¶
    get_actions(context)[source]¶

    Returns the list of action information for this action.

    class ReviewRequestActionHook(extension, actions=[], *args, **kwargs)[source]¶

    Bases: reviewboard.extensions.hooks.ActionHook

    A hook for adding an action to the review request page.

    hooks = [][source]¶
    class ReviewRequestDropdownActionHook(extension, actions=[], *args, **kwargs)[source]¶

    Bases: reviewboard.extensions.hooks.ActionHook

    A hook for adding an drop down action to the review request page.

    The actions for a drop down action should contain:

    • id: The ID of this action (optional).
    • label: The label of the drop-down.
    • items: A list of ActionHook-style dicts (see ActionHook params).

    For example:

    actions = [{
        'id': 'id 0',
        'label': 'Title',
        'items': [
            {
                'id': 'id 1',
                'label': 'Item 1',
                'url': '...',
            },
            {
                'id': 'id 2',
                'label': 'Item 2',
                'url': '...',
            }
        ]
    }]
    
    hooks = [][source]¶
    class DiffViewerActionHook(extension, actions=[], *args, **kwargs)[source]¶

    Bases: reviewboard.extensions.hooks.ActionHook

    A hook for adding an action to the diff viewer page.

    hooks = [][source]¶
    class HeaderActionHook(extension, actions=[], *args, **kwargs)[source]¶

    Bases: reviewboard.extensions.hooks.ActionHook

    A hook for putting an action in the page header.

    hooks = [][source]¶
    class HeaderDropdownActionHook(extension, actions=[], *args, **kwargs)[source]¶

    Bases: reviewboard.extensions.hooks.ActionHook

    A hook for putting multiple actions into a header dropdown.

    hooks = [][source]¶
    class UserPageSidebarItemsHook(extension, item_classes)[source]¶

    Bases: reviewboard.extensions.hooks.DataGridSidebarItemsHook

    A hook for adding items to the sidebar of the user page.

    Extensions can use this hook to plug new items into the sidebar of the user page. These will appear below the built-in items.

    The items can be any subclass of reviewboard.datagrids.sidebar.BaseSidebarItem, including the built-in reviewboard.datagrids.sidebar.BaseSidebarSection and built-in reviewboard.datagrids.sidebar.SidebarNavItem.

    __init__(extension, item_classes)[source]¶
    class EmailHook(extension, signals=None)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    A hook for changing the recipients of e-mails.

    Extensions can use this hook to change the contents of the To and CC fields of e-mails. This should be subclassed in an extension to provide the desired behaviour. This class is a base class for more specialized extension hooks. If modifying only one type of e-mail’s fields is desired, one of the following classes should be sub-classed instead.

    • ReviewPublishedEmailHook
    • ReviewReplyPublishedEmailHook
    • ReviewRequestPublishedEmailHook
    • ReviewRequestClosedEmailHook

    However, if more specialized behaviour is desired, this class can be sub-classed.

    __init__(extension, signals=None)[source]¶

    Initialize the EmailHook.

    Parameters:
    • extension (reviewboard.extensions.base.Extension) – The extension creating this hook.
    • signals (list) –

      A list of Signals that, when triggered, will cause e-mails to be sent. Valid signals are:

      • review_request_published
      • review_request_closed
      • review_published
      • reply_published
    shutdown()[source]¶

    Unregister the e-mail handlers.

    get_to_field(to_field, **kwargs)[source]¶

    Return the To field for the e-mail.

    Parameters:
    • to_field (set) – A set of Users and Groups that will receive the e-mail.
    • kwargs (dict) – Additional keyword arguments that will be passed based on the type of e-mail being sent.
    Returns:

    The desired To field.

    Return type:

    set

    get_cc_field(cc_field, **kwargs)[source]¶

    Return the CC field for the e-mail.

    Parameters:
    • cc_field (set) – A set of Users and Groups that will receive a carbon copy of the e-mail.
    • kwargs (dict) – Additional keyword arguments that will be passed based on the type of e-mail being sent.
    Returns:

    The desired CC field.

    Return type:

    set

    hooks = [][source]¶
    class ReviewPublishedEmailHook(extension)[source]¶

    Bases: reviewboard.extensions.hooks.EmailHook

    A hook for changing the recipients of review publishing e-mails.

    __init__(extension)[source]¶

    Initialize the ReviewPublishedEmailHook.

    Parameters:extension (reviewboard.extensions.base.Extension) – The extension registering this hook.
    get_to_field(to_field, review, user, review_request)[source]¶

    Return the To field for the e-mail.

    Parameters:
    • to_field (set) – A set of Users and Groups that will receive the e-mail.
    • review (reviewboard.reviews.models.Review) – The review that was published.
    • user (django.contrib.auth.models.User) – The user who published the review.
    • review_request (reviewboard.reviews.models.ReviewRequest) – The review request that was reviewed.
    Returns:

    The desired To field.

    Return type:

    set

    get_cc_field(cc_field, review, user, review_request)[source]¶

    Return the CC field for the e-mail.

    Parameters:
    • to_field (set) – A set of Users and Groups that will receive a carbon copy of the e-mail.
    • review (reviewboard.reviews.models.Review) – The review that was published.
    • user (django.contrib.auth.models.User) – The user who published the review.
    • review_request (reviewboard.reviews.models.ReviewRequest) – The review request that was reviewed.
    Returns:

    The desired CC field.

    Return type:

    set

    class ReviewReplyPublishedEmailHook(extension)[source]¶

    Bases: reviewboard.extensions.hooks.EmailHook

    A hook for changing the recipients of review reply publishing e-mails.

    __init__(extension)[source]¶

    Initialize the ReviewReplyPublishedEmailHook.

    Parameters:extension (djblets.extensions.Extension) – The extension registering this hook.
    get_to_field(to_field, reply, user, review_request)[source]¶

    Return the To field for the e-mail.

    Parameters:
    • to_field (set) – A set of Users and Groups that will receive the e-mail.
    • reply (reviewboard.reviews.models.Review) – The review reply that was published.
    • user (django.contrib.auth.models.User) – The user who published the review reply.
    • review (reviewboard.reviews.model.Review) – The review the reply is in reply to.
    • review_request (reviewboard.reviews.models.ReviewRequest) – The review request that was reviewed.
    Returns:

    The desired To field.

    Return type:

    set

    get_cc_field(cc_field, reply, user, review_request)[source]¶

    Return the CC field for the e-mail.

    Parameters:
    • to_field (set) – A set of Users and Groups that will receive a carbon copy of the e-mail
    • reply (reviewboard.reviews.models.Review) – The review reply that was published.
    • user (django.contrib.auth.models.User) – The user who published the reply.
    • review_request (reviewboard.reviews.models.ReviewRequest) – The review request that was reviewed.
    Returns:

    The desired CC field.

    Return type:

    set

    class ReviewRequestClosedEmailHook(extension)[source]¶

    Bases: reviewboard.extensions.hooks.EmailHook

    A hook for changing the recipients of review request closing e-mails.

    __init__(extension)[source]¶

    Initialize the ReviewRequestClosedEmailHook.

    Parameters:extension (reviewboard.extensions.base.Extension) – The extension registering this hook.
    get_to_field(to_field, review_request, user, close_type)[source]¶

    Return the To field for the e-mail.

    Parameters:
    • to_field (set) – A set of Users and Groups that will receive the e-mail.
    • review_request (reviewboard.reviews.models.ReviewRequest) – The review request that was published.
    • user (django.contrib.auth.models.User) – The user who closed the review request.
    • close_type (unicode) – How the review request was closed. This is one of SUBMITTED or DISCARDED.
    Returns:

    The desired To field.

    Return type:

    set

    get_cc_field(cc_field, review_request, user, close_type)[source]¶

    Return the CC field for the e-mail.

    Parameters:
    • to_field (set) – A set of Users and Groups that will receive a carbon copy of the e-mail.
    • review_request (reviewboard.reviews.models.ReviewRequest) – The review request that was published.
    • user (django.contrib.auth.models.User) – The user who closed the review request.
    • close_type (unicode) – How the review request was closed. This is one of SUBMITTED or DISCARDED.
    Returns:

    The desired CC field.

    Return type:

    set

    class ReviewRequestPublishedEmailHook(extension)[source]¶

    Bases: reviewboard.extensions.hooks.EmailHook

    A hook for changing the recipients of review request publishing e-mails.

    __init__(extension)[source]¶

    Initialize the ReviewRequestPublishedEmailHook.

    Parameters:extension (reviewboard.extensions.base.Extension) – The extension registering this hook.
    get_to_field(to_field, review_request, user)[source]¶

    Return the To field for the e-mail.

    Parameters:
    • to_field (set) – A set of Users and Groups that will receive the e-mail.
    • review_request (reviewboard.reviews.models.ReviewRequest) – The review request that was published.
    • user (django.contrib.auth.models.User) – The user who published the review request.
    Returns:

    The desired To field.

    Return type:

    set

    get_cc_field(cc_field, review_request, user)[source]¶

    Return the CC field for the e-mail.

    Parameters:
    • to_field (set) – A set of Users and Groups that will receive a carbon copy of the e-mail.
    • review_request (reviewboard.reviews.models.ReviewRequest) – The review request that was published.
    • user (django.contrib.auth.models.User) – The user who published the review request.
    Returns:

    The desired CC field.

    Return type:

    set

    class DataGridColumnsHook(extension, datagrid_cls, columns)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    Adds columns to a datagrid.

    This hook allows an extension to register new columns to any datagrid. These columns can be added by the user, rearranged, and sorted, like any other column.

    Each column must have an id already set, and it must be unique.

    __init__(extension, datagrid_cls, columns)[source]¶
    hooks = [][source]¶
    shutdown()[source]¶
    class ExtensionHook(extension)[source]¶

    Bases: object

    The base class for a hook into some part of the project.

    ExtensionHooks are classes that can hook into an ExtensionHookPoint to provide some level of functionality in a project. A project should provide a subclass of ExtensionHook that will provide functions for getting data or anything else that’s needed, and then extensions will subclass that specific ExtensionHook.

    A base ExtensionHook subclass must use ExtensionHookPoint as a metaclass. For example:

    from django.utils import six
    
    @six.add_metaclass(ExtensionHookPoint)
    class NavigationHook(ExtensionHook):
    
    __init__(extension)[source]¶
    shutdown()[source]¶
    class SignalHook(extension, signal, callback, sender=None, sandbox_errors=True)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    Connects to a Django signal.

    This will handle connecting to a signal, calling the specified callback when fired. It will disconnect from the signal when the extension is disabled.

    The callback will also be passed an extension= keyword argument pointing to the extension instance.

    __init__(extension, signal, callback, sender=None, sandbox_errors=True)[source]¶
    hooks = [][source]¶
    shutdown()[source]¶
    class TemplateHook(extension, name, template_name=None, apply_to=[], extra_context={})[source]¶

    Bases: djblets.extensions.hooks.AppliesToURLMixin, djblets.extensions.hooks.ExtensionHook

    Custom templates hook.

    A hook that renders a template at hook points defined in another template.

    __init__(extension, name, template_name=None, apply_to=[], extra_context={})[source]¶
    classmethod by_name(name)[source]¶
    get_extra_context(request, context)[source]¶

    Returns extra context for the hook.

    Subclasses can override this to provide additional context dynamically beyond what’s passed in to the constructor.

    By default, an empty dictionary is returned.

    hooks = [][source]¶
    render_to_string(request, context)[source]¶

    Renders the content for the hook.

    By default, this renders the provided template name to a string and returns it.

    shutdown()[source]¶
    class URLHook(extension, patterns)[source]¶

    Bases: djblets.extensions.hooks.ExtensionHook

    Custom URL hook.

    A hook that installs custom URLs. These URLs reside in a project-specified parent URL.

    __init__(extension, patterns)[source]¶
    hooks = [][source]¶
    shutdown()[source]¶

    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]