class documentation

class PaperAsFilesValue(bb.Union): (source)

View In Hierarchy

The value for ``UserFeature.paper_as_files``. 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.PaperAsFilesValue.enabled: When this value is true, the user's Paper docs are accessible in Dropbox with the .paper extension and must be accessed via the /files endpoints. When this value is false, the user's Paper docs are stored separate from Dropbox files and folders and should be accessed via the /paper endpoints.

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's Paper docs are accessible in Dropbox with the .paper extension and must be accessed via the /files endpoints. When this value is false, the user's Paper docs are stored separate from Dropbox files and folders and should be accessed via the /paper endpoints.
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: PaperAsFilesValue

def get_enabled(self): (source)

When this value is true, the user's Paper docs are accessible in Dropbox with the .paper extension and must be accessed via the /files endpoints. When this value is false, the user's Paper docs are stored separate from Dropbox files and folders and should be accessed via the /paper endpoints. 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

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented