:right-sidebar: True

Period
===================================================================

.. currentmodule:: gi.repository.ICalGLib





.. class:: Period(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.ICalGLib.Object`, :class:`~gi.repository.GObject.Object`





This is the ICalPeriod instance.


Constructors
------------

.. rst-class:: interim-class

.. class:: Period
   :no-index:


   .. classmethod:: new_from_string(str: str) -> ~gi.repository.ICalGLib.Period

      Creates a :obj:`~gi.repository.ICalGLib.Period` from a string.


      .. versionadded:: 1.0





      :param str: The string used to create the :obj:`~gi.repository.ICalGLib.Period`




   .. classmethod:: new_null_period() -> ~gi.repository.ICalGLib.Period

      Creates a default :obj:`~gi.repository.ICalGLib.Period`\.


      .. versionadded:: 1.0












Methods
-------

.. rst-class:: interim-class

.. class:: Period
   :no-index:


   .. method:: as_ical_string() -> str

      Translates :obj:`~gi.repository.ICalGLib.Period` to string.



      .. versionadded:: 1.0








   .. method:: get_duration() -> ~gi.repository.ICalGLib.Duration

      Gets the duration from an :obj:`~gi.repository.ICalGLib.Period`\.



      .. versionadded:: 1.0








   .. method:: get_end() -> ~gi.repository.ICalGLib.Time

      Gets the end time from an :obj:`~gi.repository.ICalGLib.Period`\.



      .. versionadded:: 1.0








   .. method:: get_start() -> ~gi.repository.ICalGLib.Time

      Gets the start time from an :obj:`~gi.repository.ICalGLib.Period`\.



      .. versionadded:: 1.0








   .. method:: is_null_period() -> bool

      Checks the :obj:`~gi.repository.ICalGLib.Period` is null_period.



      .. versionadded:: 1.0








   .. method:: is_valid_period() -> bool

      Checks the :obj:`~gi.repository.ICalGLib.Period` is valid_period.



      .. versionadded:: 1.0








   .. method:: set_duration(duration: ~gi.repository.ICalGLib.Duration) -> None

      Sets the duration of an :obj:`~gi.repository.ICalGLib.Period`\.



      .. versionadded:: 1.0





      :param duration: The duration of ``period``




   .. method:: set_end(end: ~gi.repository.ICalGLib.Time) -> None

      Sets the end time of an :obj:`~gi.repository.ICalGLib.Period`\.



      .. versionadded:: 1.0





      :param end: The end of ``period``




   .. method:: set_start(start: ~gi.repository.ICalGLib.Time) -> None

      Sets the start time of an :obj:`~gi.repository.ICalGLib.Period`\.



      .. versionadded:: 1.0





      :param start: The start of ``period``