Skip to content

Commit

Permalink
Updated README to reflect the returns from lock and unlock_permissions
Browse files Browse the repository at this point in the history
  • Loading branch information
Bryant Howell committed Jan 6, 2020
1 parent d520289 commit 614679e
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -912,12 +912,18 @@ For Projects, since the standard `query_project()` method returns the Project ob

Projects have additional commands that the other classes do not:

`Project.lock_permissions()`
`Project.lock_permissions() -> Project`

`Project.unlock_permission()`
`Project.unlock_permission() -> Project`

`Project.are_permissions_locked()`

If you are locking or unlocking permissions, you should replace the project object you used with the response that comes back:

proj = t.projects.query_project('My Project')
proj = proj.lock_permissions() # You want to updated object returned here to use from here on out
...

You access the default permissions objects with the following, which reference the objects of the correct type that have already been built within the Project object:

`Project.workbook_defaults`
Expand Down

0 comments on commit 614679e

Please sign in to comment.