class documentation

class PlatformType(bb.Union): (source)

View In Hierarchy

Possible platforms on which a user may view content. 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 seen_state.PlatformType.web: The content was viewed on the web. :ivar seen_state.PlatformType.desktop: The content was viewed on a desktop client. :ivar seen_state.PlatformType.mobile_ios: The content was viewed on a mobile iOS client. :ivar seen_state.PlatformType.mobile_android: The content was viewed on a mobile android client. :ivar seen_state.PlatformType.api: The content was viewed from an API client. :ivar seen_state.PlatformType.unknown: The content was viewed on an unknown platform. :ivar seen_state.PlatformType.mobile: The content was viewed on a mobile client. DEPRECATED: Use mobile_ios or mobile_android instead.

Method is_api Check if the union tag is ``api``.
Method is_desktop Check if the union tag is ``desktop``.
Method is_mobile Check if the union tag is ``mobile``.
Method is_mobile_android Check if the union tag is ``mobile_android``.
Method is_mobile_ios Check if the union tag is ``mobile_ios``.
Method is_other Check if the union tag is ``other``.
Method is_unknown Check if the union tag is ``unknown``.
Method is_web Check if the union tag is ``web``.
Class Variable api Undocumented
Class Variable desktop Undocumented
Class Variable mobile Undocumented
Class Variable mobile_android Undocumented
Class Variable mobile_ios Undocumented
Class Variable other Undocumented
Class Variable unknown Undocumented
Class Variable web Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_api(self): (source)

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

def is_desktop(self): (source)

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

def is_mobile(self): (source)

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

def is_mobile_android(self): (source)

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

def is_mobile_ios(self): (source)

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

def is_other(self): (source)

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

def is_unknown(self): (source)

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

def is_web(self): (source)

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

Undocumented

Undocumented

Undocumented

mobile_android = (source)

Undocumented

mobile_ios = (source)

Undocumented

Undocumented

Undocumented

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented