Skip to content

BrandingConfiguration

Source code in docs_src/capo_workspaces_web/types/branding_configuration.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class BrandingConfiguration(TypedDict, closed=True):
    logo: "capo_workspaces_web.types.image_metadata.ImageMetadata"
    """<p>Metadata for the logo image file, including the MIME type, file extension, and upload timestamp.</p>"""
    wallpaper: NotRequired["capo_workspaces_web.types.image_metadata.ImageMetadata"]
    """<p>Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp.</p>"""
    favicon: "capo_workspaces_web.types.image_metadata.ImageMetadata"
    """<p>Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp.</p>"""
    localized_strings: "capo_workspaces_web.types.localized_branding_string_map.LocalizedBrandingStringMap"
    """<p>A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.</p>"""
    color_theme: "capo_workspaces_web.types.color_theme.ColorTheme"
    """<p>The color theme for components on the web portal.</p>"""
    terms_of_service: NotRequired["capo_workspaces_web.types.markdown.Markdown"]
    """<p>The terms of service text in Markdown format that users must accept before accessing the portal.</p>"""

color_theme instance-attribute 

color_theme: ColorTheme

The color theme for components on the web portal.

favicon instance-attribute 

favicon: ImageMetadata

Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp.

localized_strings instance-attribute 

localized_strings: LocalizedBrandingStringMap

A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.

logo: ImageMetadata

Metadata for the logo image file, including the MIME type, file extension, and upload timestamp.

terms_of_service instance-attribute 

terms_of_service: NotRequired[Markdown]

The terms of service text in Markdown format that users must accept before accessing the portal.

wallpaper instance-attribute 

wallpaper: NotRequired[ImageMetadata]

Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp.