PyPublishableWorkbook
class PyPublishableWorkbook(publishable_workbook)
Bases: PyWorkbookDetails, PyConnectionsContent
Interface for an IWorkbook that has been downloaded and has full information necessary for re-publishing.
- Parameters: publishable_workbook (IPublishableWorkbook)
__init__(publishable_workbook)
Creates a new PyPublishableWorkbook object.
Args: : publishable_workbook: A IPublishableWorkbook object.
Returns: None.
- Parameters: publishable_workbook (IPublishableWorkbook)
- Return type: None
Methods
__init__(publishable_workbook) |
Creates a new PyPublishableWorkbook object. |
|---|
Attributes
connections |
Gets the connection metadata. |
|---|---|
container |
Gets the container for the content item. |
content_url |
Get the site-unique "content URL" of the content item, or an empty string if the content type does not use a content URL. |
created_at |
Gets the created timestamp. |
description |
Gets or sets the description. |
encrypt_extracts |
Gets or sets whether or not extracts are encrypted. |
hidden_view_names |
Gets the names of the views that should be hidden. |
id |
Gets the unique identifier. |
location |
Gets the logical location path of the content item, for project-level content this is the project path and the content item name. |
name |
Gets the name of the content item. |
owner |
Gets or sets the owner for the content item. |
show_tabs |
Gets or sets whether tabs are shown. |
size |
Gets the file size. |
tags |
Gets or sets the tags for the content item. |
thumbnails_user_id |
Gets the ID of the user to generate thumbnails as. |
updated_at |
Gets the updated timestamp. |
views |
Gets the view metadata. |
webpage_url |
Gets the webpage URL. |
property connections : Sequence[PyConnection]
Gets the connection metadata. Connection metadata is read only because connection metadata should not be transformed directly. Instead, connections should be modified by either: 1) manipulating XML before publishing, or 2) updating connection metadata in a post-publish hook.
property container : PyContentReference
Gets the container for the content item. Relocating the content should be done through mapping.
property content_url : str
Get the site-unique “content URL” of the content item, or an empty string if the content type does not use a content URL.
property created_at : str
Gets the created timestamp.
property description : str
Gets or sets the description.
property encrypt_extracts : bool
Gets or sets whether or not extracts are encrypted.
property hidden_view_names : Sequence[str]
Gets the names of the views that should be hidden.
property id : UUID
Gets the unique identifier.
property location : PyContentLocation
Gets the logical location path of the content item, for project-level content this is the project path and the content item name.
property name : str
Gets the name of the content item. This is equivalent to the last segment of the Location. Renames should be performed through mapping.
property owner : PyContentReference
Gets or sets the owner for the content item.
property show_tabs : bool
Gets or sets whether tabs are shown.
property size : int
Gets the file size.
property tags : List[PyTag]
Gets or sets the tags for the content item.
property thumbnails_user_id : UUID
Gets the ID of the user to generate thumbnails as.
property updated_at : str
Gets the updated timestamp.
property views : Sequence[PyView]
Gets the view metadata.
property webpage_url : str
Gets the webpage URL.