dropbox.users.FileLockingValue

class documentation

class FileLockingValue(bb.Union): (source)

The value for ``UserFeature.file_locking``. 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 bool users.FileLockingValue.enabled: When this value is True, the user can lock files in shared directories. When the value is False the user can unlock the files they have locked or request to unlock files locked by others.

Class Method	`enabled`	Create an instance of this class set to the ``enabled`` tag with value ``val``.
Method	`get_enabled`	When this value is True, the user can lock files in shared directories. When the value is False the user can unlock the files they have locked or request to unlock files locked by others.
Method	`is_enabled`	Check if the union tag is ``enabled``.
Method	`is_other`	Check if the union tag is ``other``.
Class Variable	`other`	Undocumented
Method	`_process_custom_annotations`	Undocumented
Class Variable	`_catch_all`	Undocumented

@classmethod
def enabled(cls, val): (source) ¶

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

def get_enabled(self): (source) ¶

When this value is True, the user can lock files in shared directories. When the value is False the user can unlock the files they have locked or request to unlock files locked by others. Only call this if :meth:`is_enabled` is true. :rtype: bool

def is_enabled(self): (source) ¶

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

def is_other(self): (source) ¶

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

other = (source) ¶

Undocumented

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

Undocumented

_catch_all: str = (source) ¶

Undocumented