class documentation

class DocSubscriptionLevel(bb.Union): (source)

View In Hierarchy

The subscription level of a Paper doc. 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 paper.DocSubscriptionLevel.default: No change email messages unless you're the creator. :ivar paper.DocSubscriptionLevel.ignore: Ignored: Not shown in pad lists or activity and no email message is sent. :ivar paper.DocSubscriptionLevel.every: Subscribed: Shown in pad lists and activity and change email messages are sent. :ivar paper.DocSubscriptionLevel.no_email: Unsubscribed: Shown in pad lists, but not in activity and no change email messages are sent.

Method is_default Check if the union tag is ``default``.
Method is_every Check if the union tag is ``every``.
Method is_ignore Check if the union tag is ``ignore``.
Method is_no_email Check if the union tag is ``no_email``.
Class Variable default Undocumented
Class Variable every Undocumented
Class Variable ignore Undocumented
Class Variable no_email Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_default(self): (source)

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

def is_every(self): (source)

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

def is_ignore(self): (source)

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

def is_no_email(self): (source)

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

Undocumented

Undocumented

Undocumented

no_email = (source)

Undocumented

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

Undocumented

_catch_all = (source)

Undocumented