Index

Module to interact with Views.

This module contains class to interact with Views in Apps.

PublishedView

Bases: PublishedContentNode

View object to interact with view specific apps endpoints.

actions class-attribute instance-attribute

actions = Field(None, alias='actions')

activated_draft_id class-attribute instance-attribute

activated_draft_id = Field(None, alias='activatedDraftId')

archived_at class-attribute instance-attribute

archived_at = Field(None, alias='archivedAt')

archived_by class-attribute instance-attribute

archived_by = Field(None, alias='archivedBy')

asset class-attribute instance-attribute

asset = Field(None, alias='asset')

asset_metadata_transport class-attribute instance-attribute

asset_metadata_transport = Field(
    None, alias="assetMetadataTransport"
)

asset_type class-attribute instance-attribute

asset_type = Field(None, alias='assetType')

base class-attribute instance-attribute

base = Field(None, alias='base')

change_date class-attribute instance-attribute

change_date = Field(None, alias='changeDate')

created_by_id class-attribute instance-attribute

created_by_id = Field(None, alias='createdById')

creation_date class-attribute instance-attribute

creation_date = Field(None, alias='creationDate')

deleted_at class-attribute instance-attribute

deleted_at = Field(None, alias='deletedAt')

deleted_by class-attribute instance-attribute

deleted_by = Field(None, alias='deletedBy')

draft_id class-attribute instance-attribute

draft_id = Field(None, alias='draftId')

embeddable class-attribute instance-attribute

embeddable = Field(None, alias='embeddable')

folder class-attribute instance-attribute

folder = Field(None, alias='folder')

grouped_resource_type_to_actions class-attribute instance-attribute

grouped_resource_type_to_actions = Field(
    None, alias="groupedResourceTypeToActions"
)

id instance-attribute

id

Id of apps content node.

identifier class-attribute instance-attribute

identifier = Field(None, alias='identifier')

input_variable_definitions class-attribute instance-attribute

input_variable_definitions = Field(
    None, alias="inputVariableDefinitions"
)

invalid_content class-attribute instance-attribute

invalid_content = Field(None, alias='invalidContent')

key instance-attribute

key

Key of apps content node.

name class-attribute instance-attribute

name = Field(None, alias='name')

node_type class-attribute instance-attribute

node_type = Field(None, alias='nodeType')

object_id class-attribute instance-attribute

object_id = Field(None, alias='objectId')

order class-attribute instance-attribute

order = Field(None, alias='order')

parent_node_id class-attribute instance-attribute

parent_node_id = Field(None, alias='parentNodeId')

parent_node_key class-attribute instance-attribute

parent_node_key = Field(None, alias='parentNodeKey')

permissions class-attribute instance-attribute

permissions = Field(None, alias='permissions')

public_available class-attribute instance-attribute

public_available = Field(None, alias='publicAvailable')

resource_path class-attribute instance-attribute

resource_path = Field(None, alias='resourcePath')

root class-attribute instance-attribute

root = Field(None, alias='root')

root_node_id class-attribute instance-attribute

root_node_id = Field(None, alias='rootNodeId')

root_node_key class-attribute instance-attribute

root_node_key = Field(None, alias='rootNodeKey')

root_with_key class-attribute instance-attribute

root_with_key = Field(None, alias='rootWithKey')

schema_version class-attribute instance-attribute

schema_version = Field(None, alias='schemaVersion')

serialization_type class-attribute instance-attribute

serialization_type = Field(None, alias='serializationType')

serialized_content instance-attribute

serialized_content

Serialized content of content node.

show_in_viewer_mode class-attribute instance-attribute

show_in_viewer_mode = Field(None, alias='showInViewerMode')

source class-attribute instance-attribute

source = Field(None, alias='source')

space_id instance-attribute

space_id

Id of space where content node is located.

tenant_id class-attribute instance-attribute

tenant_id = Field(None, alias='tenantId')

updated_by class-attribute instance-attribute

updated_by = Field(None, alias='updatedBy')

version class-attribute instance-attribute

version = Field(None, alias='version')

working_draft_id class-attribute instance-attribute

working_draft_id = Field(None, alias='workingDraftId')

client class-attribute instance-attribute

client = Field(..., exclude=True)

from_transport classmethod

from_transport(client, content_node_transport)

Creates high-level published content node object from given ContentNodeTransport.

Parameters:

• client (Client) –

  Client to use to make API calls for given published content node.

• content_node_transport (ContentNodeTransport) –

  ContentNodeTransport object containing properties of published content node.

Returns:

• PublishedContentNode –

  A PublishedContentNode object with properties from transport and given client.

sync

sync()

Syncs content node properties with EMS.

get_content

get_content()

Returns content of view.

Returns:

• Optional[ViewContent] –

  View content.

Examples:

Extract table from view content:

table = view.get_content().components.find_by_id(
    "<component_id>"
)