class documentation

class LinkPermissions(bb.Struct): (source)

View In Hierarchy

:ivar sharing.LinkPermissions.resolved_visibility: The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. :ivar sharing.LinkPermissions.requested_visibility: The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in ``resolved_visibility``. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience. :ivar sharing.LinkPermissions.can_revoke: Whether the caller can revoke the shared link. :ivar sharing.LinkPermissions.revoke_failure_reason: The failure reason for revoking the link. This field will only be present if the ``can_revoke`` is ``False``. :ivar sharing.LinkPermissions.effective_audience: The type of audience who can benefit from the access level specified by the `link_access_level` field. :ivar sharing.LinkPermissions.link_access_level: The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content. :ivar sharing.LinkPermissions.visibility_policies: A list of policies that the user might be able to set for the visibility. :ivar sharing.LinkPermissions.can_set_expiry: Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry. :ivar sharing.LinkPermissions.can_remove_expiry: Whether the user can remove the expiry of the link. :ivar sharing.LinkPermissions.allow_download: Whether the link can be downloaded or not. :ivar sharing.LinkPermissions.can_allow_download: Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link. :ivar sharing.LinkPermissions.can_disallow_download: Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link. :ivar sharing.LinkPermissions.allow_comments: Whether comments are enabled for the linked file. This takes the team commenting policy into account. :ivar sharing.LinkPermissions.team_restricts_comments: Whether the team has disabled commenting globally. :ivar sharing.LinkPermissions.audience_options: A list of link audience options the user might be able to set as the new audience. :ivar sharing.LinkPermissions.can_set_password: Whether the user can set a password for the link. :ivar sharing.LinkPermissions.can_remove_password: Whether the user can remove the password of the link. :ivar sharing.LinkPermissions.require_password: Whether the user is required to provide a password to view the link. :ivar sharing.LinkPermissions.can_use_extended_sharing_controls: Whether the user can use extended sharing controls, based on their account type.

Method __init__ Undocumented
Class Variable __slots__ Undocumented
Instance Variable allow_comments Undocumented
Instance Variable allow_download Undocumented
Instance Variable audience_options Undocumented
Instance Variable can_allow_download Undocumented
Instance Variable can_disallow_download Undocumented
Instance Variable can_remove_expiry Undocumented
Instance Variable can_remove_password Undocumented
Instance Variable can_revoke Undocumented
Instance Variable can_set_expiry Undocumented
Instance Variable can_set_password Undocumented
Instance Variable can_use_extended_sharing_controls Undocumented
Instance Variable effective_audience Undocumented
Instance Variable link_access_level Undocumented
Instance Variable requested_visibility Undocumented
Instance Variable require_password Undocumented
Instance Variable resolved_visibility Undocumented
Instance Variable revoke_failure_reason Undocumented
Instance Variable team_restricts_comments Undocumented
Instance Variable visibility_policies Undocumented
Method _process_custom_annotations Undocumented
Class Variable _has_required_fields Undocumented
Instance Variable _allow_comments_value Undocumented
Instance Variable _allow_download_value Undocumented
Instance Variable _audience_options_value Undocumented
Instance Variable _can_allow_download_value Undocumented
Instance Variable _can_disallow_download_value Undocumented
Instance Variable _can_remove_expiry_value Undocumented
Instance Variable _can_remove_password_value Undocumented
Instance Variable _can_revoke_value Undocumented
Instance Variable _can_set_expiry_value Undocumented
Instance Variable _can_set_password_value Undocumented
Instance Variable _can_use_extended_sharing_controls_value Undocumented
Instance Variable _effective_audience_value Undocumented
Instance Variable _link_access_level_value Undocumented
Instance Variable _requested_visibility_value Undocumented
Instance Variable _require_password_value Undocumented
Instance Variable _resolved_visibility_value Undocumented
Instance Variable _revoke_failure_reason_value Undocumented
Instance Variable _team_restricts_comments_value Undocumented
Instance Variable _visibility_policies_value Undocumented
def __init__(self, can_revoke=None, visibility_policies=None, can_set_expiry=None, can_remove_expiry=None, allow_download=None, can_allow_download=None, can_disallow_download=None, allow_comments=None, team_restricts_comments=None, resolved_visibility=None, requested_visibility=None, revoke_failure_reason=None, effective_audience=None, link_access_level=None, audience_options=None, can_set_password=None, can_remove_password=None, require_password=None, can_use_extended_sharing_controls=None): (source)

Undocumented

__slots__: list[str] = (source)

Undocumented

allow_comments = (source)

Undocumented

allow_download = (source)

Undocumented

audience_options = (source)

Undocumented

can_allow_download = (source)

Undocumented

can_disallow_download = (source)

Undocumented

can_remove_expiry = (source)

Undocumented

can_remove_password = (source)

Undocumented

can_revoke = (source)

Undocumented

can_set_expiry = (source)

Undocumented

can_set_password = (source)

Undocumented

can_use_extended_sharing_controls = (source)

Undocumented

effective_audience = (source)

Undocumented

link_access_level = (source)

Undocumented

requested_visibility = (source)

Undocumented

require_password = (source)

Undocumented

resolved_visibility = (source)

Undocumented

revoke_failure_reason = (source)

Undocumented

team_restricts_comments = (source)

Undocumented

visibility_policies = (source)

Undocumented

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

Undocumented

_has_required_fields: bool = (source)

Undocumented

_allow_comments_value = (source)

Undocumented

_allow_download_value = (source)

Undocumented

_audience_options_value = (source)

Undocumented

_can_allow_download_value = (source)

Undocumented

_can_disallow_download_value = (source)

Undocumented

_can_remove_expiry_value = (source)

Undocumented

_can_remove_password_value = (source)

Undocumented

_can_revoke_value = (source)

Undocumented

_can_set_expiry_value = (source)

Undocumented

_can_set_password_value = (source)

Undocumented

_can_use_extended_sharing_controls_value = (source)

Undocumented

_effective_audience_value = (source)

Undocumented

_link_access_level_value = (source)

Undocumented

_requested_visibility_value = (source)

Undocumented

_require_password_value = (source)

Undocumented

_resolved_visibility_value = (source)

Undocumented

_revoke_failure_reason_value = (source)

Undocumented

_team_restricts_comments_value = (source)

Undocumented

_visibility_policies_value = (source)

Undocumented