class documentation

class UserFeatureValue(bb.Union): (source)

View In Hierarchy

Values that correspond to entries in :class:`UserFeature`. 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.

Class Method file_locking Create an instance of this class set to the ``file_locking`` tag with value ``val``.
Class Method paper_as_files Create an instance of this class set to the ``paper_as_files`` tag with value ``val``.
Method get_file_locking Only call this if :meth:`is_file_locking` is true.
Method get_paper_as_files Only call this if :meth:`is_paper_as_files` is true.
Method is_file_locking Check if the union tag is ``file_locking``.
Method is_other Check if the union tag is ``other``.
Method is_paper_as_files Check if the union tag is ``paper_as_files``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def file_locking(cls, val): (source)

Create an instance of this class set to the ``file_locking`` tag with value ``val``. :param FileLockingValue val: :rtype: UserFeatureValue

@classmethod
def paper_as_files(cls, val): (source)

Create an instance of this class set to the ``paper_as_files`` tag with value ``val``. :param PaperAsFilesValue val: :rtype: UserFeatureValue

def get_file_locking(self): (source)

Only call this if :meth:`is_file_locking` is true. :rtype: FileLockingValue

def get_paper_as_files(self): (source)

Only call this if :meth:`is_paper_as_files` is true. :rtype: PaperAsFilesValue

def is_file_locking(self): (source)

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

def is_other(self): (source)

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

def is_paper_as_files(self): (source)

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

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented