RenameObjectFile

Renames a document file.

Syntax

// Assumes shellUI has been initialized with IShellUI instance
const results = await shellUI.Vault.ObjectOperations.RenameObjectFile({
  obj_ver: {
    obj_id: {
      type: 0,
      item_id: {
        internal_id: 0,
        external_repository_id: {
          connection: "<connection>",
          item: "<item>",
        },
      },
    },
    version: {
      type: 7 /* Enum: ObjVerVersionType */,
      internal_version: 0,
      external_repository_version: "<external repository version>",
      external_repository_sort_key: 0,
    },
  },
  file_ver: {
    file_id: {
      type: 3 /* Enum: FileIDType */,
      internal_id: 0,
      external_repository_id: "<external repository id>",
    },
    type: 3 /* Enum: FileVerType */,
    internal_version: 0,
    external_repository_version: "<external repository version>",
    external_repository_sort_key: 0,
  },
  title: "<title>",
  extension: "<extension>",
});

Message

Name	Description	Type
obj_ver	The object version as JSON. (represented by MF_ObjVer struct)	ObjVer
file_ver	The file to be renamed as JSON. (represented by MF_FileVer struct)	FileVer
title	The new title of the file.	string
extension	The new extension of the file, not including the dot (e.g. "doc").	string

Return type

Name	Description	Type
object_version	Information about the latest version of the document after the operation (if *pbLatestVisible is true) as JSON.	ObjectVersionEx

Example

{
  "object_version": {
    "version_info": {
      "version": {
        "type": 7 /* Enum: ObjVerVersionType */,
        "internal_version": 0,
        "external_repository_version": "<external repository version>",
        "external_repository_sort_key": 0
      },
      "title": "<title>",
      "is_single_file_object": false,
      "has_assignments": false,
      "last_modified_at_utc": {
        "seconds": 0,
        "nanos": 0
      } /* google.protobuf.Timestamp */,
      "files": [] /* Array of File */,
      "object_version_flags": {
        "all": false,
        "is_assignment_completed": false,
        "has_related_objects": false,
        "is_assignment_rejected": false,
        "has_file_duplicates": false
      },
      "class_id": 0,
      "version_guid": "<version guid>",
      "primary_file": {
        "type": 3 /* Enum: FileIDType */,
        "internal_id": 0,
        "external_repository_id": "<external repository id>"
      }
    },
    "object_info": {
      "obj_id": {
        "type": 0,
        "item_id": {
          "internal_id": 0,
          "external_repository_id": {
            "connection": "<connection>",
            "item": "<item>"
          }
        }
      },
      "external_id_status": 5 /* Enum: ExtIDStatus */,
      "external_id": "<external id>",
      "checked_out_version": {} /* ObjVerVersion */,
      "checked_out_to_user_id": 0,
      "checked_out_to_user_name": "<checked out to user name>",
      "checked_out_to_host_name": "<checked out to host name>",
      "checked_out_at_utc": {
        "seconds": 0,
        "nanos": 0
      } /* google.protobuf.Timestamp */,
      "checked_in_version": {} /* ObjVerVersion */,
      "created_at_utc": {
        "seconds": 0,
        "nanos": 0
      } /* google.protobuf.Timestamp */,
      "accessed_by_me_utc": {
        "seconds": 0,
        "nanos": 0
      } /* google.protobuf.Timestamp */,
      "guid": "<guid>",
      "options": {
        "all": false,
        "is_shortcut": false,
        "is_deleted": false,
        "is_accessed_by_valid": false,
        "has_shared_files": false,
        "is_conflict_object": false,
        "is_normal": false,
        "is_view": false,
        "has_external_data": false,
        "is_referred_external_object": false,
        "is_external_origin": false,
        "is_omitted_from_database": false
      },
      "original_vault_guid": "<original vault guid>",
      "original_vault_obj_id": {} /* ObjID */,
      "associated_view_id": {} /* ItemID */,
      "external_repository_icon_id": "<external repository icon id>",
      "primary_view_id": {} /* ItemID */,
      "capabilities": {
        "all": false,
        "can_have_history": false,
        "can_have_relationships": false,
        "can_edit_old_versions": false,
        "can_delete": false,
        "can_destroy": false,
        "can_undelete": false,
        "can_rename": false,
        "can_edit_metadata": false,
        "can_edit_assignments": false,
        "can_edit_workflows": false,
        "can_edit_files": false,
        "can_edit_version_comments": false,
        "can_convert_single_multi_file": false,
        "can_add_and_remove_files": false,
        "can_change_file_type": false,
        "can_change_permissions": false
      }
    }
  }
}