on_resource_list Event
Fires once for each resource returned when listing resources or versions.
Syntax
class BoxResourceListEventParams(object): @property def id() -> str: ... @property def name() -> str: ... @property def description() -> str: ... @property def resource_type() -> int: ... @property def created_time() -> str: ... @property def modified_time() -> str: ... @property def size() -> int: ... @property def version_id() -> str: ... @property def e_tag() -> str: ... @property def hash() -> str: ... @property def trashed() -> bool: ... @property def shared_link() -> str: ... # In class Box: @property def on_resource_list() -> Callable[[BoxResourceListEventParams], None]: ... @on_resource_list.setter def on_resource_list(event_hook: Callable[[BoxResourceListEventParams], None]) -> None: ...
Remarks
This event fires once for each resource returned when list_resources, get_resource_info, search, or list_versions is called.
Id is the Id of the resource.
Name is the name of the resource.
Description is a description of the resource.
ResourceType reflects the resource's type. Possible values are:
| 0 (brtFile) | A file. |
| 1 (brtFolder) | A folder. |
CreatedTime and ModifiedTime reflect the resource's creation and last modified timestamps. Timestamps are formatted according to RFC 3339.
Size is the size of the resource (for folders, their contents' total size), in bytes.
VersionId is the version Id of the file resource. Not applicable for file resources. (Note that Box only tracks file versions for paid accounts.)
ETag is the ETag of the resource.
Hash holds a SHA1 hash of the file resource's content. Not applicable for folder resources.
Trashed indicates whether the resource is in the trash.
SharedLink is the shared link URL for the resource. May be empty if the resource doesn't have a shared link active.