class documentation

class Visibility(bb.Union): (source)

View In Hierarchy

Who can access a shared link. The most open visibility is ``public``. The default depends on many aspects, such as team and user preferences and shared folder settings. 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.Visibility.public: Anyone who has received the link can access it. No login required. :ivar sharing.Visibility.team_only: Only members of the same team can access the link. Login is required. :ivar sharing.Visibility.password: A link-specific password is required to access the link. Login is not required. :ivar sharing.Visibility.team_and_password: Only members of the same team who have the link-specific password can access the link. :ivar sharing.Visibility.shared_folder_only: Only members of the shared folder containing the linked file can access the link. Login is required.

Method is_other Check if the union tag is ``other``.
Method is_password Check if the union tag is ``password``.
Method is_public Check if the union tag is ``public``.
Method is_shared_folder_only Check if the union tag is ``shared_folder_only``.
Method is_team_and_password Check if the union tag is ``team_and_password``.
Method is_team_only Check if the union tag is ``team_only``.
Class Variable other Undocumented
Class Variable password Undocumented
Class Variable public Undocumented
Class Variable shared_folder_only Undocumented
Class Variable team_and_password Undocumented
Class Variable team_only Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_other(self): (source)

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

def is_password(self): (source)

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

def is_public(self): (source)

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

def is_shared_folder_only(self): (source)

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

def is_team_and_password(self): (source)

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

def is_team_only(self): (source)

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

Undocumented

password = (source)

Undocumented

Undocumented

shared_folder_only = (source)

Undocumented

team_and_password = (source)

Undocumented

team_only = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented