class documentation

class SharedFileMetadata(bb.Struct): (source)

View In Hierarchy

Properties of the shared file. :ivar sharing.SharedFileMetadata.access_type: The current user's access level for this shared file. :ivar sharing.SharedFileMetadata.id: The ID of the file. :ivar sharing.SharedFileMetadata.expected_link_metadata: The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet. :ivar sharing.SharedFileMetadata.link_metadata: The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet. :ivar sharing.SharedFileMetadata.name: The name of this file. :ivar sharing.SharedFileMetadata.owner_display_names: The display names of the users that own the file. If the file is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. :ivar sharing.SharedFileMetadata.owner_team: The team that owns the file. This field is not present if the file is not owned by a team. :ivar sharing.SharedFileMetadata.parent_shared_folder_id: The ID of the parent shared folder. This field is present only if the file is contained within a shared folder. :ivar sharing.SharedFileMetadata.path_display: The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files. :ivar sharing.SharedFileMetadata.path_lower: The lower-case full path of this file. Absent for unmounted files. :ivar sharing.SharedFileMetadata.permissions: The sharing permissions that requesting user has on this file. This corresponds to the entries given in ``GetFileMetadataBatchArg.actions`` or ``GetFileMetadataArg.actions``. :ivar sharing.SharedFileMetadata.policy: Policies governing this shared file. :ivar sharing.SharedFileMetadata.preview_url: URL for displaying a web preview of the shared file. :ivar sharing.SharedFileMetadata.time_invited: Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent.

Method __init__ Undocumented
Class Variable __slots__ Undocumented
Instance Variable access_type Undocumented
Instance Variable expected_link_metadata Undocumented
Instance Variable id Undocumented
Instance Variable link_metadata Undocumented
Instance Variable name Undocumented
Instance Variable owner_display_names Undocumented
Instance Variable owner_team Undocumented
Instance Variable parent_shared_folder_id Undocumented
Instance Variable path_display Undocumented
Instance Variable path_lower Undocumented
Instance Variable permissions Undocumented
Instance Variable policy Undocumented
Instance Variable preview_url Undocumented
Instance Variable time_invited Undocumented
Method _process_custom_annotations Undocumented
Class Variable _has_required_fields Undocumented
Instance Variable _access_type_value Undocumented
Instance Variable _expected_link_metadata_value Undocumented
Instance Variable _id_value Undocumented
Instance Variable _link_metadata_value Undocumented
Instance Variable _name_value Undocumented
Instance Variable _owner_display_names_value Undocumented
Instance Variable _owner_team_value Undocumented
Instance Variable _parent_shared_folder_id_value Undocumented
Instance Variable _path_display_value Undocumented
Instance Variable _path_lower_value Undocumented
Instance Variable _permissions_value Undocumented
Instance Variable _policy_value Undocumented
Instance Variable _preview_url_value Undocumented
Instance Variable _time_invited_value Undocumented
def __init__(self, id=None, name=None, policy=None, preview_url=None, access_type=None, expected_link_metadata=None, link_metadata=None, owner_display_names=None, owner_team=None, parent_shared_folder_id=None, path_display=None, path_lower=None, permissions=None, time_invited=None): (source)

Undocumented

__slots__: list[str] = (source)

Undocumented

access_type = (source)

Undocumented

expected_link_metadata = (source)

Undocumented

Undocumented

link_metadata = (source)

Undocumented

Undocumented

owner_display_names = (source)

Undocumented

owner_team = (source)

Undocumented

parent_shared_folder_id = (source)

Undocumented

path_display = (source)

Undocumented

path_lower = (source)

Undocumented

permissions = (source)

Undocumented

Undocumented

preview_url = (source)

Undocumented

time_invited = (source)

Undocumented

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

Undocumented

_has_required_fields: bool = (source)

Undocumented

_access_type_value = (source)

Undocumented

_expected_link_metadata_value = (source)

Undocumented

_id_value = (source)

Undocumented

_link_metadata_value = (source)

Undocumented

_name_value = (source)

Undocumented

_owner_display_names_value = (source)

Undocumented

_owner_team_value = (source)

Undocumented

_parent_shared_folder_id_value = (source)

Undocumented

_path_display_value = (source)

Undocumented

_path_lower_value = (source)

Undocumented

_permissions_value = (source)

Undocumented

_policy_value = (source)

Undocumented

_preview_url_value = (source)

Undocumented

_time_invited_value = (source)

Undocumented