Views
Classes for Views resources group
Classes:
| Name | Description |
|---|---|
Views |
Views resources method group main class |
Classes
Views
Bases: outline_wiki_api.resources.base.Resources
Views represent a compressed record of an individual users views of a
document. Individual views are not recorded but a first, last and total
is kept per user.
Methods:
| Name | Description |
|---|---|
list |
List all views for a document |
create |
Creates a view for a document (not recommended to use outside of the UI, but still implemented for testing purposes) |
Functions
create
Creates a new view for a document. This is documented in the interests of thoroughness however it is recommended that views are not created from outside of the Outline UI.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
document_id
|
typing.Union[str, uuid.UUID]
|
The id of the document to create a view for |
required |
Returns:
| Name | Type | Description |
|---|---|---|
ViewResponse |
The created view response object |
list
List all users that have viewed a document and the overall view
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
document_id
|
typing.Union[str, uuid.UUID]
|
The id of the document to list views for |
required |
Returns:
| Name | Type | Description |
|---|---|---|
ViewListResponse |
a response object which contains a View object as data |