cterasdk.cio.core.commands module

cterasdk.cio.core.commands module#

class cterasdk.cio.core.commands.AddMembers(function, receiver, path, metadata, new_members)#: Bases: Share

class cterasdk.cio.core.commands.Copy(function, receiver, block, *paths, destination=None, resolver=None, cursor=None)#: Bases: ResolverCommand

class cterasdk.cio.core.commands.CreateDirectory(function, receiver, path, parents=False)#

Bases: PortalCommand

Create Directory

get_parameter()#

class cterasdk.cio.core.commands.Delete(function, receiver, block, *paths)#: Bases: MultiResourceCommand

class cterasdk.cio.core.commands.Download(function, receiver, path, properties=None, objects=None, destination=None)#

Bases: PortalCommand

get_parameter()#

class cterasdk.cio.core.commands.EnsureDirectory(function, receiver, path, suppress_error=False)#: Bases: PortalCommand

class cterasdk.cio.core.commands.FilterShareMembers(function, receiver, members, cloud_folder_uid)#: Bases: PortalCommand

class cterasdk.cio.core.commands.GetExternalShareInfo(function, receiver, invite)#

Bases: PortalCommand

get_parameter()#

class cterasdk.cio.core.commands.GetMetadata(function, receiver, path, suppress_error=False)#: Bases: ListDirectory

class cterasdk.cio.core.commands.GetPermalink(function, receiver, path, suppress_error=False)#: Bases: GetMetadata

class cterasdk.cio.core.commands.GetProperties(function, receiver, path, suppress_error=False)#: Bases: GetMetadata

class cterasdk.cio.core.commands.GetShareMetadata(function, receiver, path)#

Bases: PortalCommand

get_parameter()#

class cterasdk.cio.core.commands.Link(function, receiver, path, access, expire_in)#

Bases: PortalCommand

get_parameter()#

class cterasdk.cio.core.commands.ListDirectory(function, receiver, path, depth, include_deleted, search_criteria, limit)#

Bases: PortalCommand

List

get_parameter()#

class cterasdk.cio.core.commands.ListVersions(function, receiver, path)#

Bases: PortalCommand

get_parameter()#

class cterasdk.cio.core.commands.Move(function, receiver, block, *paths, destination=None, resolver=None, cursor=None)#: Bases: ResolverCommand

class cterasdk.cio.core.commands.MultiResourceCommand(function, receiver, block, *paths)#

Bases: TaskCommand

get_parameter()#

class cterasdk.cio.core.commands.Open(function, receiver, path, properties, objects)#

Bases: PortalCommand

Open file

get_parameter()#

class cterasdk.cio.core.commands.PathResolver(listdir, receiver, destination, default)#

Bases: object

async a_resolve()#

resolve()#

class cterasdk.cio.core.commands.Recover(function, receiver, block, *paths)#: Bases: MultiResourceCommand

class cterasdk.cio.core.commands.RecursiveIterator(function, receiver, path, include_deleted)#

Bases: object

async a_generate()#

generate()#

class cterasdk.cio.core.commands.RemoveMembers(function, receiver, path, metadata, members)#: Bases: Share

class cterasdk.cio.core.commands.Rename(function, receiver, block, path, new_name, resolver, cursor=None)#: Bases: Move

class cterasdk.cio.core.commands.ResolverCommand(function, receiver, block, *paths, destination=None, resolver=None, cursor=None)#

Bases: TaskCommand

async a_execute()#

execute()#

get_parameter()#

class cterasdk.cio.core.commands.ResourceIterator(function, receiver, path, depth, include_deleted, search_criteria, limit)#

Bases: ListDirectory

async a_execute()#

execute()#

class cterasdk.cio.core.commands.SearchMember(function, receiver, account, cloud_folder_uid)#

Bases: PortalCommand

get_parameter()#

class cterasdk.cio.core.commands.Share(function, receiver, path, members, as_project, allow_reshare, allow_sync)#

Bases: PortalCommand

get_parameter()#

class cterasdk.cio.core.commands.TaskCommand(function, receiver, block)#: Bases: PortalCommand

class cterasdk.cio.core.commands.UnShare(function, receiver, path)#: Bases: Share

class cterasdk.cio.core.commands.Upload(function, receiver, listdir, destination, fd, name, size)#

Bases: PortalCommand

get_parameter()#

async cterasdk.cio.core.commands.a_split_file_directory(listdir, receiver, destination)#

Split a path into its parent directory and final component.

Returns:

tuple[str, str]: A (parent_directory, name) tuple when:

The path refers to an existing file
The path refers to an existing directory
The parent directory of the path exists

Raises:

cterasdk.exceptions.io.core.GetMetadataError – If neither the path nor its parent directory exist.

cterasdk.cio.core.commands.administrator_namespace(path)#

cterasdk.cio.core.commands.collaborators_from_server_object(server_collaborators)#

cterasdk.cio.core.commands.create_collaboration_parameter(path, as_project, allow_reshare, allow_sync)#

cterasdk.cio.core.commands.create_collaborator(member)#

cterasdk.cio.core.commands.destination_prerequisite_conditions(destination)#

cterasdk.cio.core.commands.ensure_user_access(user_session, path)#

Determine whether the current user has permission to access the specified path.

Parameters:

user_session (cterasdk.lib.session.Session) – The active user session used to evaluate permissions.
path (str or cterasdk.cio.core.types.PortalPath) – The target path to validate.

cterasdk.cio.core.commands.ensure_writeable(resource, directory)#

cterasdk.cio.core.commands.extend_collaborators(collaborators, valid_members)#

cterasdk.cio.core.commands.is_password_protected(path)#: Determine whether a path is password protected :returns: True if password protected, False otherwise. :rtype: bool

cterasdk.cio.core.commands.obtain_current_accounts(collaborators)#

cterasdk.cio.core.commands.raise_or_suppress_access_error(receiver, path)#

cterasdk.cio.core.commands.split_file_directory(listdir, receiver, destination)#

Split a path into its parent directory and final component.

Returns:

tuple[str, str]: A (parent_directory, name) tuple when:

The path refers to an existing file
The path refers to an existing directory
The parent directory of the path exists

Raises:

cterasdk.exceptions.io.core.GetMetadataError – If neither the path nor its parent directory exist.

cterasdk.cio.core.commands module

Contents

cterasdk.cio.core.commands module#