class documentation

class LinkExpiry(bb.Union): (source)

View In Hierarchy

This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. :ivar sharing.LinkExpiry.remove_expiry: Remove the currently set expiry for the link. :ivar datetime.datetime sharing.LinkExpiry.set_expiry: Set a new expiry or change an existing expiry.

Class Method set_expiry Create an instance of this class set to the ``set_expiry`` tag with value ``val``.
Method get_set_expiry Set a new expiry or change an existing expiry.
Method is_other Check if the union tag is ``other``.
Method is_remove_expiry Check if the union tag is ``remove_expiry``.
Method is_set_expiry Check if the union tag is ``set_expiry``.
Class Variable other Undocumented
Class Variable remove_expiry Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def set_expiry(cls, val): (source)

Create an instance of this class set to the ``set_expiry`` tag with value ``val``. :param datetime.datetime val: :rtype: LinkExpiry

def get_set_expiry(self): (source)

Set a new expiry or change an existing expiry. Only call this if :meth:`is_set_expiry` is true. :rtype: datetime.datetime

def is_other(self): (source)

Check if the union tag is ``other``. :rtype: bool

def is_remove_expiry(self): (source)

Check if the union tag is ``remove_expiry``. :rtype: bool

def is_set_expiry(self): (source)

Check if the union tag is ``set_expiry``. :rtype: bool

Undocumented

remove_expiry = (source)

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)

Undocumented

_catch_all: str = (source)

Undocumented