GraphApplyEditsResult

对知识图谱服务的图谱资源执行 executeApplyEdits() 的结果。汇总对图谱的编辑，并提供执行编辑时遇到的任何错误。

另请参阅

GraphApplyEdits

示例

// sample executeApplyEdits() to add a new entity
const newEntity = new Entity({
  typeName: "Supplier",
  properties: {
    Name: "Supplier 5",
    EmployeeCount: 681
  }
})

KnowledgeGraphModule.executeApplyEdits(graph, {
  entityAdds: [newEntity],
})
.then((editResult) => {
  console.log("Graph Add Result", editResult);
});

// Results of adding one entity to the `Supplier` entity type
{
  editResults:[{
    adds:[
    {
      id: "{AN4E4G85-41F1-49A4-8412-CACCC9906E88}",
      error: {errorCode: 0, errorMessage: ""}
    }],
    deletes:[],
    typeName: "Supplier",
    updates:[]
  }],
  hasError: false,
  error: undefined
}

// example results of a complex executeApplyEdits that involved
// adding, updating and deleting multiple types.
{
  editResults:[{
    adds:[
    {
      id: "{AN4E4G85-41F1-49A4-8412-CACCC9906E88}",
      error: {errorCode: 0, errorMessage: ""}
    }],
    deletes:[],
    typeName: "Supplier",
    updates:[]
  },{
    adds:[{
      id: "{ANWIFHSAS-AW6F-G9W4-8412-A1A8W4F1A5S6F}",
      error: {errorCode: 0, errorMessage: ""}
    }],
    deletes:[{
      id: "{AN4E4G85-Q15F4-49A4-8412-A1W8F4S6A5S4}",
      error: {errorCode: 0, errorMessage: ""}
    },{
      id: "{AF15W4F8S-A1W5-A1W8F-G1E8-AF1W5F4S8F4W}",
      error: {errorCode: 0, errorMessage: ""}
    }],
    typeName: "Part",
    updates:[{
      id: "{2WS8F4SA-41F1-S1E8-8412-F2G5S4D8GE1S}",
      error: {errorCode: 0, errorMessage: ""}
    }]
  }],
  hasError: false,
  error: undefined
}

// example of an error message due to misspelled entity type
{
  editResults:[],
  hasError: true,
  error: {
    errorCode: 112020,
    errorMessage: "The Entity/Relationship type definition, Suppplier, was not found."
  }
}

构造函数

new GraphApplyEditsResult()

属性

properties Object

optional

有关可能传递给构造函数的属性的完整列表，请参见属性。

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。

显示继承属性

隐藏继承属性

类型	描述	类
String	类的名称。更多详情	Accessor
editResultsObject []	返回通过 executeApplyEdits() 添加、更新或删除记录的每个实体类型或关系类型的对象列表。更多详情	GraphApplyEditsResult
Object	错误消息，解释有关 executeApplyEdits() 失败原因的信息。更多详情	GraphApplyEditsResult
Object	如果为 `true`，则处理 executeApplyEdits() 时出错。更多详情	GraphApplyEditsResult

属性详细信息

declaredClass Stringreadonly inherited

类的名称。声明的类名称格式化为 geoscene.folder.className。

editResults editResultsObject []

返回通过 executeApplyEdits() 添加、更新或删除记录的每个实体类型或关系类型的对象列表。

如果 hasError 为 true，则 editResults 将为空。

示例

editResults:[{
    adds:[
    {
      id: "{AN4E4G85-41F1-49A4-8412-CACCC9906E88}",
      error: {errorCode: 0, errorMessage: ""}
    }],
    deletes:[],
    typeName: "Supplier",
    updates:[]
  },{
    adds:[{
      id: "{ANWIFHSAS-AW6F-G9W4-8412-A1A8W4F1A5S6F}",
      error: {errorCode: 0, errorMessage: ""}
    }],
    deletes:[{
      id: "{AN4E4G85-Q15F4-49A4-8412-A1W8F4S6A5S4}",
      error: {errorCode: 0, errorMessage: ""}
    },{
      id: "{AF15W4F8S-A1W5-A1W8F-G1E8-AF1W5F4S8F4W}",
      error: {errorCode: 0, errorMessage: ""}
    }],
    typeName: "Part",
    updates:[{
      id: "{2WS8F4SA-41F1-S1E8-8412-F2G5S4D8GE1S}",
      error: {errorCode: 0, errorMessage: ""}
    }]
}],

error Object

错误消息，解释有关 executeApplyEdits() 失败原因的信息。仅当 hasError 为 true 时才会定义。

属性

errorCode int

从服务器返回的错误代码。

errorMessage String

错误的描述。

示例

// example of an error message due to misspelled entity type
{
  editResults:[],
  hasError: false,
  error: {
    errorCode: 112020,
    errorMessage: "The Entity/Relationship type definition, Suppplier, was not found."
  }
}

hasError Object

如果为 true，则处理 executeApplyEdits() 时出错。错误消息在错误属性中捕获。

默认值：false

方法概述

显示继承的方法

隐藏继承的方法

返回值类值	描述	类
	添加一个或多个与对象的生命周期相关联的句柄。更多详情	Accessor
Boolean	如果存在指定的句柄组，则返回 true。更多详情	Accessor
	移除对象拥有的句柄组。更多详情	Accessor

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

参数

handleOrHandles WatchHandle|WatchHandle []

对象销毁后，标记为要移除的句柄。

groupKey *

optional

标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

hasHandles(groupKey){Boolean}inherited

如果存在指定的句柄组，则返回 true。

参数

groupKey *

optional

组键。

类型	描述
Boolean	如果存在指定的句柄组，则返回 `true`。

示例

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles(groupKey)inherited

移除对象拥有的句柄组。

参数

groupKey *

optional

要移除的密钥组或密钥组的数组或集合。

示例

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

类型定义

editResultsObject Object

editResultsObject 返回从 KnowledgeGraph 中添加、更新或删除的每种类型的所有实体和关系列表，以及操作过程中发生的任何错误。

属性

typeName String

已更改项目的 EntityType 或 RelationshipType 的名称。

adds NamedObjectEditResults []

包含每个已添加实体或关系的 id 和错误信息的对象列表。

updates NamedObjectEditResults []

包含每个已更新实体或关系的 id 和错误信息的对象列表。

deletes NamedObjectEditResults []

包含每个已删除实体或关系的 id 和错误信息的对象列表。

示例

{
  adds:[{
      id: "{ANWIFHSAS-AW6F-G9W4-8412-A1A8W4F1A5S6F}",
      error: {errorCode: 0, errorMessage: ""}
    }],
    deletes:[{
      id: "{AN4E4G85-Q15F4-49A4-8412-A1W8F4S6A5S4}",
      error: {errorCode: 0, errorMessage: ""}
    },{
      id: "{AF15W4F8S-A1W5-A1W8F-G1E8-AF1W5F4S8F4W}",
      error: {errorCode: 0, errorMessage: ""}
    }],
    typeName: "Part",
    updates:[{
      id: "{2WS8F4SA-41F1-S1E8-8412-F2G5S4D8GE1S}",
      error: {errorCode: 0, errorMessage: ""}
    }]
}

NamedObjectEditResults Object

NamedObjectEditResults 包含从 KnowledgeGraph 添加、更新或删除的 GraphNamedObject (Entity 或关系) 的 id，以及操作过程中发生的任何错误。

属性

id String

从知识图谱中添加、更新或删除的实体或关系的 id。

error Object

指示应用于此对象的操作过程中导致的任何错误。

规范

errorCode int

从服务器返回的错误代码。

errorMessage String

错误的描述。

示例

// typical structure
{
  id: "{2WS8F4SA-41F1-S1E8-8412-F2G5S4D8GE1S}", //id of entity or relationship added, updated or deleted
  error: {errorCode: 0, errorMessage: ""}
}

GeoScene Maps SDK for JavaScript参考手册

构造函数

属性概述

属性详细信息

方法概述

方法详细说明

类型定义