remote_id Property

Selects a remote resource by Id.

Syntax

def get_remote_id() -> str: ...
def set_remote_id(value: str) -> None: ...

remote_id = property(get_remote_id, set_remote_id)

Default Value

""

Remarks

This property selects a remote file or folder resource to operate against using its resource Id.

Remote Id and Path Notes

Keep the following things in mind when setting the remote_id and/or remote_path properties:

• If both remote_id and remote_path are set, remote_id is used.
• The Id or path provided must always be for a resource that resides in the drive currently selected by drive.
• Some methods operate against only file or only folder resources; while others can operate against either one. Calling a method while remote_id/remote_path is set to the Id/path of a resource whose type is unsupported will cause the server to return an error; use the table below to determine which resource types each method supports.

  Method Name	Files	Folders
  copy_resource	X	X
  create_folder	-	X
  create_link	X	X
  delete_resource	X	X
  download_file	X	-
  get_resource_info	X	X
  list_resources	-	X
  move_resource	X	X
  search	-	X
  update_resource	X	X
  upload_file	-	X

  Key: X = Supported; - = Not supported.

• Methods that support only folder resources can also operate against the root of the currently selected drive, just clear both remote_id and remote_path.
• Some methods may have other restrictions, refer to each one for more information.

Note: The rules regarding acceptable resource types still apply if using the RelativePath configuration setting in tandem with this property. That is, ensure that the resource that the relative path resolves to is of an acceptable type.