class documentation

class FileCategory(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 files.FileCategory.image: jpg, png, gif, and more. :ivar files.FileCategory.document: doc, docx, txt, and more. :ivar files.FileCategory.pdf: pdf. :ivar files.FileCategory.spreadsheet: xlsx, xls, csv, and more. :ivar files.FileCategory.presentation: ppt, pptx, key, and more. :ivar files.FileCategory.audio: mp3, wav, mid, and more. :ivar files.FileCategory.video: mov, wmv, mp4, and more. :ivar files.FileCategory.folder: dropbox folder. :ivar files.FileCategory.paper: dropbox paper doc. :ivar files.FileCategory.others: any file not in one of the categories above.

Method is_audio Check if the union tag is ``audio``.
Method is_document Check if the union tag is ``document``.
Method is_folder Check if the union tag is ``folder``.
Method is_image Check if the union tag is ``image``.
Method is_other Check if the union tag is ``other``.
Method is_others Check if the union tag is ``others``.
Method is_paper Check if the union tag is ``paper``.
Method is_pdf Check if the union tag is ``pdf``.
Method is_presentation Check if the union tag is ``presentation``.
Method is_spreadsheet Check if the union tag is ``spreadsheet``.
Method is_video Check if the union tag is ``video``.
Class Variable audio Undocumented
Class Variable document Undocumented
Class Variable folder Undocumented
Class Variable image Undocumented
Class Variable other Undocumented
Class Variable others Undocumented
Class Variable paper Undocumented
Class Variable pdf Undocumented
Class Variable presentation Undocumented
Class Variable spreadsheet Undocumented
Class Variable video Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_audio(self): (source)

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

def is_document(self): (source)

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

def is_folder(self): (source)

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

def is_image(self): (source)

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

def is_other(self): (source)

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

def is_others(self): (source)

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

def is_paper(self): (source)

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

def is_pdf(self): (source)

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

def is_presentation(self): (source)

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

def is_spreadsheet(self): (source)

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

def is_video(self): (source)

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

Undocumented

document = (source)

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

presentation = (source)

Undocumented

spreadsheet = (source)

Undocumented

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented