class documentation

class LinkAudience(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.LinkAudience.public: Link is accessible by anyone. :ivar sharing.LinkAudience.team: Link is accessible only by team members. :ivar sharing.LinkAudience.no_one: The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights. :ivar sharing.LinkAudience.password: Use `require_password` instead. A link-specific password is required to access the link. Login is not required. :ivar sharing.LinkAudience.members: Link is accessible only by members of the content.

Method is_members Check if the union tag is ``members``.
Method is_no_one Check if the union tag is ``no_one``.
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_team Check if the union tag is ``team``.
Class Variable members Undocumented
Class Variable no_one Undocumented
Class Variable other Undocumented
Class Variable password Undocumented
Class Variable public Undocumented
Class Variable team Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_members(self): (source)

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

def is_no_one(self): (source)

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

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_team(self): (source)

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

Undocumented

Undocumented

Undocumented

password = (source)

Undocumented

Undocumented

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented