Skip to content

Option

Option

Bases: BaseFormItem

An option for a Choice question.

Source code in pygsuite/forms/generated/option.py
class Option(BaseFormItem):
    """
    An option for a Choice question.
    """

    def __init__(  # noqa: C901
        self,
        go_to_action: Optional[str] = None,
        go_to_section_id: Optional[str] = None,
        image: Optional["Image"] = None,
        is_other: Optional[bool] = None,
        value: Optional[str] = None,
        object_info: Optional[Dict] = None,
    ):
        generated: Dict = {}

        if go_to_action is not None:

            generated["goToAction"] = go_to_action
        if go_to_section_id is not None:

            generated["goToSectionId"] = go_to_section_id
        if image is not None:

            generated["image"] = image._info
        if is_other is not None:

            generated["isOther"] = is_other
        if value is not None:

            generated["value"] = value
        object_info = object_info or generated
        super().__init__(object_info=object_info)

    @property
    def go_to_action(self) -> str:
        return self._info.get("goToAction")

    @go_to_action.setter
    def go_to_action(self, value: str):
        if self._info.get("goToAction", None) == value:
            return
        self._info["goToAction"] = value

    @property
    def go_to_section_id(self) -> str:
        return self._info.get("goToSectionId")

    @go_to_section_id.setter
    def go_to_section_id(self, value: str):
        if self._info.get("goToSectionId", None) == value:
            return
        self._info["goToSectionId"] = value

    @property
    def image(self) -> "Image":
        return Image(object_info=self._info.get("image"))

    @image.setter
    def image(self, value: "Image"):
        if self._info.get("image", None) == value:
            return
        self._info["image"] = value

    @property
    def is_other(self) -> bool:
        return self._info.get("isOther")

    @is_other.setter
    def is_other(self, value: bool):
        if self._info.get("isOther", None) == value:
            return
        self._info["isOther"] = value

    @property
    def value(self) -> str:
        return self._info.get("value")

    @value.setter
    def value(self, value: str):
        if self._info.get("value", None) == value:
            return
        self._info["value"] = value