GetLayoutObjectOwnerInfo
レイアウトオブジェクトの所有権情報を含む JSON オブジェクトを返します。
構文
GetLayoutObjectOwnerInfo (オブジェクト ID)
引数
オブジェクト ID
- レイアウトオブジェクトの UUID (Universally Unique Identifier) または所有者 ID を表すテキスト。
戻り値のデータタイプ
テキスト
起点バージョン
19.2.2
説明
この関数は、UUID または所有者 ID がオブジェクト ID
引数と一致するレイアウトオブジェクトを検索し、そのオブジェクトの所有者に関する情報を返します。次のものがレイアウトオブジェクトの所有者と見なされます。
-
オブジェクトが配置されているレイアウト
-
オブジェクトが含まれているアドオン (該当する場合)
レイアウトオブジェクトがレイアウトに追加されるときには、UUID が割り当てられます。アドオンのインスタンスがレイアウトに追加されるときには、所有者 ID が割り当てられます。オブジェクト ID
引数の値として、オブジェクトの UUID または所有者 ID のいずれかを指定できます。LayoutObjectUUID 関数を参照してください。
アドオンのデベロッパは、この関数を使用して、アドオンのインスタンスに含まれているレイアウトオブジェクトの情報を実行時に取得できます。
次の例で返される JSON オブジェクトでは、レイアウトオブジェクトは Tasks というレイアウト上のアドオンのインスタンス内にあります。
{
"APIVers" :1,
"Object" :
{
"UUID" :"D7C30E98-1924-4BF5-A263-53E9CD36862F",
"Index" :1,
"Name" :"ActivityTimeLineWV_970E9CAE-D6FA-40DE-ACFA-14D110731F82",
"Owners" :
{
"Add-on" :
{
"InstanceID" :"38EA3124-9CFD-4490-A634-A0A72A613145"
},
"Layout" :
{
"UUID" :"D7C30E98-1924-4BF5-A263-53E9CD36862F",
"Name" :"Tasks"
}
}
}
}
次の表に、返される JSON オブジェクトの要素に関する説明を示します。
JSON 要素 |
説明 |
---|---|
APIVers
|
この JSON オブジェクトの構造のバージョン番号を表す数値。今後のリリースで JSON オブジェクトの構造が変化すると、この番号も変わります。 |
Object.UUID
|
指定されたレイアウトオブジェクトの UUID |
Object.Index
|
レイアウト上のオブジェクトの、ゼロから始まるインデックス |
Object.Name
|
レイアウトオブジェクトの名前 (オブジェクトの名前付けを参照してください) |
Object.Owners
|
オブジェクトが含まれているアドオンインスタンスの ID。オブジェクトがアドオンに含まれていない場合、 |
Object.Owners
|
オブジェクトが配置されているレイアウトの UUID |
Object.Owners
|
オブジェクトが配置されているレイアウトの名前 |
例 1
上記の JSON オブジェクトを返します。