# -*- coding: utf-8 -*-
"""PyAdaptiveCards components wrapper.
Copyright (c) 2016-2019 Cisco and/or its affiliates.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""
from .abstract_components import Serializable
from .utils import check_type
from .options import BlockElementHeight, Spacing, ImageSize, ImageStyle, Colors, FontSize, ContainerStyle
from .actions import OpenUrl, ShowCard, Submit
class MediaSource(Serializable):
"""Defines the source of a Media element."""
def __init__(self,
mimeType,
url):
"""Create a new MediaSource component.
Args:
mimeType(str): Mime type of the associated media(i.e. 'video/mp4')
url(str): URL of the media.
"""
# Check types
check_type(mimeType, str, False, False)
check_type(url, str, False, False)
self.mimeType = mimeType
self.url = url
super().__init__(serializable_properties=[],
simple_properties=['mimeType', 'url'])
class Media(Serializable):
"""Displays a media player for audio or video content"""
def __init__(self,
sources,
poster=None,
altText=None,
height=None,
separator=None,
spacing=None,
id=None):
"""Create a new Media component.
Args:
sources(list): A list of media sources to be played
poster(str): The url to the image that is displayed before playing
altText(str): Alternative text for this component
height(BlockElementHeight): The height of this block element
separator(bool): Draw a separating line when set to true
spacing(Spacing): Specify the spacing of this component
id(str): The id of this component
"""
# Check types
check_type(sources, MediaSource, True, False)
check_type(poster, str, False, True)
check_type(altText, str, False, True)
check_type(height, BlockElementHeight, False, True)
check_type(separator, bool, False, True)
check_type(spacing, Spacing, False, True)
check_type(id, str, False, True)
self.type = "Media"
self.sources = sources #Needs to be a list of media sources
self.poster = poster
self.altText = altText
self.height = height
self.separator = separator
self.spacing = spacing
self.id = id
super().__init__(serializable_properties=['sources'],
simple_properties=[
'type', 'poster', 'altText', 'height',
'separator', 'spacing', 'id'
])
[docs]class Image(Serializable):
"""Displays a image object"""
[docs] def __init__(self,
url,
altText=None,
backgroundColor=None,
height=None,
horizontalAlignment=None,
selectAction=None,
size=None,
style=None,
width=None,
separator=None,
spacing=None,
id=None):
"""Create a new image component
Args:
url(str): The URL to the image
altText(str): Alternative text describing the image
backgroundColor(str): Background color for transparent images.
height(str, BlockElementHeight): Height of the image either as a
pixel value(i.e. '50px') or as an instance of BlockElementHeight
horizontalAlignmnet(HorizontalAlignment): Controls how the component
is positioned within its parent.
selectAction(OpenUrl, Submit): Option that is caried out when the
card is selected.
size(ImageSize): Controls the approximate size of the image.
style(ImageStyle): The display style of this image.
width(str): Width of the image as a pixel value (i.e. '50px')
separator(bool): Draw a separating line when set to true
spacing(Spacing): Specify the spacing of this component
id(str): The id of this component
"""
check_type(url, str, False, False)
check_type(altText, str, False, True)
check_type(backgroundColor, str, False, True)
check_type(height, (str, BlockElementHeight), False, True)
check_type(horizontalAlignment, horizontalAlignment, False, True)
check_type(selectAction, (OpenUrl, Submit), False, True)
check_type(size, ImageSize, False, True)
check_type(style, ImageStyle, False, True)
check_type(width, str, False, True)
check_type(separator, bool, False, True)
check_type(spacing, Spacing, False, True)
check_type(id, str, False, True)
self.type = "Image"
self.url = url
self.altText = altText
self.backgroundColor = backgroundColor
self.height = height
self.horizontalAlignment = horizontalAlignment
self.selectAction = selectAction
self.size = size
self.style = style
self.width = width
self.separator = separator
self.spacing = spacing
self.id = id
super().__init__(serializable_properties=[],
simple_properties=[
'type', 'url', 'altText', 'backgroundColor',
'height', 'horizontalAlignment', 'selectAction',
'size', 'style', 'width', 'separator', 'spacing',
'id'
])
[docs]class TextBlock(Serializable):
"""Component that contains text."""
[docs] def __init__(self,
text,
color=None,
horizontalAlignment=None,
isSubtle=None,
maxLines=None,
size=None,
weight=None,
wrap=None,
separator=None,
spacing=None,
id=None):
"""Create a new TextBlock component.
Args:
text(str): The text to be displayed.
color(Colors): The color of the text.
horizontalAlignment(HorizontalAlignment): Controls how the component
is positioned within its parent.
isSubtle(bool): If true, displays text slightly toned down to appear
less prominent.
maxLines(int): Specifies the number of lines to display.
size(FontSize): Controls the size of the text.
weight(FontWeight): Controls the weight of a TextBlock element.
wrap(bool): If true, allow text to wrap.
separator(bool): Draw a separating line when set to true.
spacing(Spacing): Specify the spacing of this component.
id(str): The id of this component.
"""
#ToDo(mneiding): Type check
check_type(text, str, False, False)
check_type(color, Colors, False, False)
self.type = "TextBlock"
self.text = text
self.color = color
self.horizontalAlignment = horizontalAlignment
self.isSubtle = isSubtle
self.maxLines = maxLines
self.size = size
self.weight = weight
self.wrap = wrap
self.separator = separator
self.spacing = spacing
self.id = id
super().__init__(serializable_properties=[],
simple_properties=[
'type', 'text', 'color', 'horizontalAlignment',
'isSubtle', 'maxLines', 'size', 'weight', 'wrap',
'spacing', 'id', 'separator'
])
[docs]class Column(Serializable):
"""A column contains other components and (together with a ColumnSet) allows to display
multiple components under each other.
"""
[docs] def __init__(self, items=None,
separator=None,
spacing=None,
selectAction=None,
style=None,
verticalContentAlignment=None,
width=None,
id=None):
"""Create a new column.
Args:
items(list): List of components in this column
separator(bool): Draw a separating line when set to true.
spacing(Spacing): Specify the spacing of this component.
selectAction(OpenUrl, Submit): Specifies the action that is invoked when the colum is
selected.
style(ContainerStyle): The style of this column.
verticalContentAlignment(VerticalContentAlignment): The vertical alignment of the column
content.
width(str, int): The width of this column. Can be "auto", "stretch" or a number that
represents the width in pixels.
id(str): The id of this component.
"""
self.type = "Column"
self.items = items
self.separator = separator
self.spacing = spacing
self.selectAction = selectAction
self.style = style
self.verticalContentAlignment = verticalContentAlignment
self.width = width
self.id = id
super().__init__(serializable_properties=['items'],
simple_properties=[
'type', 'separator', 'spacing', 'selectAction',
'style', 'verticalContentAlignment', 'width', 'id'
])
[docs]class Fact(Serializable):
"""Fact component to display a set of facts.
"""
[docs] def __init__(self, title, value):
"""Create a new Fact.
Args:
title(str): The title of this fact
value(str): The value of this fact
"""
self.title = title
self.value = value
super().__init__(serializable_properties=[],
simple_properties=['title', 'value'])
[docs]class Choice(Serializable):
"""Choice component.
Can be used together with a ChoiceSet to display different choices.
"""
[docs] def __init__(self, title, value):
"""Create a new choice.
Args:
title(str): The title of the choice
value(str): The value of the choice
"""
self.title = title
self.value = value
super().__init__(serializable_properties=[],
simple_properties=['title', 'value'])