boxr_S3_classes function

boxr S3 Classes

boxr S3 Classes

boxr implements a series of S3 classes to manage the data returned by the Box API. These classes are built on list; if you wish to access the information directly, you can use unclass(x).

Details

‘boxr_file_reference’

  • describes a file created, modified, or deleted at Box.
  • returned by box_ul(), box_save(), box_delete_file(), etc.
  • available methods: print().

‘boxr_folder_reference’

  • describes a folder created or deleted at Box.
  • returned by box_dir_create(), box_delete_folder().
  • available methods: print().

‘boxr_dir_wide_operation_result’

  • describes the result of a directory-wide operation.
  • returned by box_fetch() and box_push().
  • available methods: print(), summary().

‘boxr_object_list’

  • describes a collection of files at Box.
  • returned by box_ls(), box_search(), and related functions.
  • available methods: print(), as.data.frame().

‘boxr_dir_comparison’

  • describes the difference between directories.
  • returned by the internal function box_dir_diff().
  • available methods: print(), summary().

‘boxr_collab’

  • describes a collaboration (sharing permission).
  • returned by box_collab_create().
  • available methods: print(), as.data.frame(), as_tibble().

‘boxr_collab_list’

  • describes a collection of collaborations.
  • returned by box_collab_get().
  • available methods: print(), as.data.frame(), as_tibble().

‘boxr_comment’

  • describes a comment on a file.
  • returned by box_comment_create().
  • available methods: print(), as.data.frame(), as_tibble().

‘boxr_comment_list’

  • describes a collection of comments on a file.
  • returned by box_comment_get().
  • available methods: print(), as.data.frame(), as_tibble().

‘boxr_version_list’

  • describes a collection of version information on a file.
  • returned by box_version_api().
  • available methods: print(), as.data.frame(), as_tibble().
  • Maintainer: Ian Lyttle
  • License: MIT + file LICENSE
  • Last published: 2021-01-19