dropbox.sharing.AddFolderMemberError

class documentation

class AddFolderMemberError(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 SharedFolderAccessError AddFolderMemberError.access_error: Unable to access shared folder. :ivar sharing.AddFolderMemberError.email_unverified: This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address `here <https://www.dropbox.com/help/317>`_. :ivar sharing.AddFolderMemberError.banned_member: The current user has been banned. :ivar AddMemberSelectorError AddFolderMemberError.bad_member: ``AddFolderMemberArg.members`` contains a bad invitation recipient. :ivar sharing.AddFolderMemberError.cant_share_outside_team: Your team policy does not allow sharing outside of the team. :ivar int sharing.AddFolderMemberError.too_many_members: The value is the member limit that was reached. :ivar int sharing.AddFolderMemberError.too_many_pending_invites: The value is the pending invite limit that was reached. :ivar sharing.AddFolderMemberError.rate_limit: The current user has hit the limit of invites they can send per day. Try again in 24 hours. :ivar sharing.AddFolderMemberError.too_many_invitees: The current user is trying to share with too many people at once. :ivar sharing.AddFolderMemberError.insufficient_plan: The current user's account doesn't support this action. An example of this is when adding a read-only member. This action can only be performed by users that have upgraded to a Pro or Business plan. :ivar sharing.AddFolderMemberError.team_folder: This action cannot be performed on a team shared folder. :ivar sharing.AddFolderMemberError.no_permission: The current user does not have permission to perform this action. :ivar sharing.AddFolderMemberError.invalid_shared_folder: Invalid shared folder error will be returned as an access_error.

Class Method access_error Create an instance of this class set to the ``access_error`` tag with value ``val``.
Class Method bad_member Create an instance of this class set to the ``bad_member`` tag with value ``val``.
Class Method too_many_members Create an instance of this class set to the ``too_many_members`` tag with value ``val``.
Class Method too_many_pending_invites Create an instance of this class set to the ``too_many_pending_invites`` tag with value ``val``.
Method get_access_error Unable to access shared folder.
Method get_bad_member ``AddFolderMemberArg.members`` contains a bad invitation recipient.
Method get_too_many_members The value is the member limit that was reached.
Method get_too_many_pending_invites The value is the pending invite limit that was reached.
Method is_access_error Check if the union tag is ``access_error``.
Method is_bad_member Check if the union tag is ``bad_member``.
Method is_banned_member Check if the union tag is ``banned_member``.
Method is_cant_share_outside_team Check if the union tag is ``cant_share_outside_team``.
Method is_email_unverified Check if the union tag is ``email_unverified``.
Method is_insufficient_plan Check if the union tag is ``insufficient_plan``.
Method is_invalid_shared_folder Check if the union tag is ``invalid_shared_folder``.
Method is_no_permission Check if the union tag is ``no_permission``.
Method is_other Check if the union tag is ``other``.
Method is_rate_limit Check if the union tag is ``rate_limit``.
Method is_team_folder Check if the union tag is ``team_folder``.
Method is_too_many_invitees Check if the union tag is ``too_many_invitees``.
Method is_too_many_members Check if the union tag is ``too_many_members``.
Method is_too_many_pending_invites Check if the union tag is ``too_many_pending_invites``.
Class Variable banned_member Undocumented
Class Variable cant_share_outside_team Undocumented
Class Variable email_unverified Undocumented
Class Variable insufficient_plan Undocumented
Class Variable invalid_shared_folder Undocumented
Class Variable no_permission Undocumented
Class Variable other Undocumented
Class Variable rate_limit Undocumented
Class Variable team_folder Undocumented
Class Variable too_many_invitees Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def access_error(cls, val): (source)

Create an instance of this class set to the ``access_error`` tag with value ``val``. :param SharedFolderAccessError val: :rtype: AddFolderMemberError

@classmethod
def bad_member(cls, val): (source)

Create an instance of this class set to the ``bad_member`` tag with value ``val``. :param AddMemberSelectorError val: :rtype: AddFolderMemberError

@classmethod
def too_many_members(cls, val): (source)

Create an instance of this class set to the ``too_many_members`` tag with value ``val``. :param int val: :rtype: AddFolderMemberError

@classmethod
def too_many_pending_invites(cls, val): (source)

Create an instance of this class set to the ``too_many_pending_invites`` tag with value ``val``. :param int val: :rtype: AddFolderMemberError

def get_access_error(self): (source)

Unable to access shared folder. Only call this if :meth:`is_access_error` is true. :rtype: SharedFolderAccessError

def get_bad_member(self): (source)

``AddFolderMemberArg.members`` contains a bad invitation recipient. Only call this if :meth:`is_bad_member` is true. :rtype: AddMemberSelectorError

def get_too_many_members(self): (source)

The value is the member limit that was reached. Only call this if :meth:`is_too_many_members` is true. :rtype: int

def get_too_many_pending_invites(self): (source)

The value is the pending invite limit that was reached. Only call this if :meth:`is_too_many_pending_invites` is true. :rtype: int

def is_access_error(self): (source)

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

def is_bad_member(self): (source)

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

def is_banned_member(self): (source)

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

def is_cant_share_outside_team(self): (source)

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

def is_email_unverified(self): (source)

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

def is_insufficient_plan(self): (source)

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

def is_invalid_shared_folder(self): (source)

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

def is_no_permission(self): (source)

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

def is_other(self): (source)

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

def is_rate_limit(self): (source)

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

def is_team_folder(self): (source)

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

def is_too_many_invitees(self): (source)

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

def is_too_many_members(self): (source)

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

def is_too_many_pending_invites(self): (source)

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

banned_member = (source)

Undocumented

cant_share_outside_team = (source)

Undocumented

email_unverified = (source)

Undocumented

insufficient_plan = (source)

Undocumented

invalid_shared_folder = (source)

Undocumented

no_permission = (source)

Undocumented

other = (source)

Undocumented

rate_limit = (source)

Undocumented

team_folder = (source)

Undocumented

too_many_invitees = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented