変数
アプリケーションで変数を使用することで、現在のユーザーに関する情報、現在選択済の1つ以上のアイテム、およびその他の情報タイプを動的に提供できます。 アプリケーションが使用されるとき、変数は実行時に評価されます。
変数名とともにカテゴリ・プレフィクス(itemまたはuser)を使用すると、特にnameなどの変数名が同じ場合に、関係を明示できます。 変数にカテゴリのプレフィクスがない場合、itemがカテゴリとして使用されます。
たとえば、フォルダまたはファイル名を指定するには、item.nameを使用します。 ユーザー名を指定するには、user.nameを使用します。 カテゴリを指定せずにnameを指定すると、item.name (フォルダまたはファイル名)が想定されます。
フォルダおよびファイルのアイテム変数
次の変数は、ユーザーによって現在選択されているフォルダ・アイテムまたはファイル・アイテムに固有です。 フォルダおよびファイル変数は、itemカテゴリに属します。 次の表に、フォルダ・アイテムとファイル・アイテムの両方に適用される変数を示します。
| フォルダまたはファイル変数 | 説明 |
|---|---|
|
id |
アイテムのGUID |
|
name |
アイテム名 |
|
description |
アイテムの説明 |
|
type |
アイテム・タイプ |
|
parentid |
アイテムの親ID |
|
ownerId |
アイテム所有者のGUID |
|
ownername |
アイテム所有者名 |
|
creatorname |
アイテム作成者名 |
|
createdat |
アイテムが作成された日時 |
|
lastmodifierid |
アイテムを直前に変更したユーザーのGUID |
|
lastmodifiername |
アイテムを直前に変更したユーザーの名前 |
|
modifiedat |
アイテムが最後に変更された日時 |
|
size |
アイテムのサイズ |
|
permissions |
ユーザーがアイテムで実行を許可されているアクション |
|
state |
アイテムの状態 |
|
applink |
|
|
favorite |
アイテムがユーザーのお気に入りかどうか |
ファイル・アイテム固有の変数
次の変数は、ユーザーによって現在選択されているファイル・アイテムに固有です。 ファイル変数はitemカテゴリに属します。 ファイル・アイテムのみに適用される変数を表に示します。
| ファイル変数 | 説明 |
|---|---|
|
originalname |
アイテムの元の名前 |
|
extension |
アイテムの拡張子 |
|
revision |
アイテムのリビジョン |
|
mimetype |
アイテムのMIMEタイプ |
|
reservedbyid |
アイテムを予約したユーザーのGUID |
|
reservedbyname |
アイテムを予約したユーザーの名前 |
|
reservedat |
アイテムが予約された日時 |
|
isreservedbyanotheruser |
アイテムが現行ユーザー以外のユーザーによって予約されているかどうか |
アイテム権限
Permissionsは、アイテムに関連付けられている権限を判別するために問い合せることができるJSONオブジェクトです。 プロパティはブール値を返します。
| 権限プロパティ | 説明 |
|---|---|
|
annotationDelete |
ユーザーにはアイテム上の注釈の削除権限があります。 |
|
annotationRead |
ユーザーにはアイテム上の注釈の読取り権限があります。 |
|
annotationUpdate |
ユーザーにはアイテム上の注釈の更新権限があります。 |
|
annotationWrite |
ユーザーにはアイテム上の注釈の書取り権限があります。 |
|
directShareDelete |
ユーザーにはユーザーと共有されているアイテムの削除権限があります。 |
|
directShareRead |
ユーザーにはユーザーと共有されているアイテムの読取り権限があります。 |
|
directShareUpdate |
ユーザーにはユーザーと共有されているアイテムの更新権限があります。 |
|
directShareWrite |
ユーザーにはユーザーと共有されているアイテムの書込み権限があります。 |
|
fileDelete |
ユーザーにはファイルの削除権限があります。 |
|
filePreview |
ユーザーにはファイルのプレビュー権限があります。 |
|
fileRead |
ユーザーにはファイルの読取り権限があります。 |
|
fileUpdate |
ユーザーにはファイルの更新権限があります。 |
|
fileWrite |
ユーザーにはファイルの書取り権限があります。 |
|
folderDelete |
ユーザーにはフォルダの削除権限があります。 |
|
folderPreview |
ユーザーにはフォルダのプレビュー権限があります。 |
|
folderRead |
ユーザーにはフォルダの読取り権限があります。 |
|
folderUpdate |
ユーザーにはフォルダの更新権限があります。 |
|
folderWrite |
ユーザーにはフォルダの書取り権限があります。 |
|
linkShareDelete |
ユーザーにはリンクによってユーザーと共有されているアイテムの削除権限があります。 |
|
linkShareRead |
ユーザーにはリンクによってユーザーと共有されているアイテムの読取り権限があります。 |
|
linkShareUpdate |
ユーザーにはリンクによってユーザーと共有されているアイテムの更新権限があります。 |
|
linkShareWrite |
ユーザーにはリンクによってユーザーと共有されているアイテムの書込み権限があります。 |
アイテムの状態
Stateは、アイテムの特定の状態を判断するために問合せできるJSONオブジェクトです。 プロパティはブール値を返します。
| 状態プロパティ | 説明 |
|---|---|
|
isAnnotated |
アイテムには注釈があります。 |
|
isAnnotatedLatest |
アイテムには最新の注釈があります。 |
|
isLinked |
アイテムには、このために定義された、名前付きの共有リンクがあります。 |
|
isShared |
アイテムは指定されたユーザーと直接共有されています。 |
|
isSyncd |
アイテムはデスクトップ・クライアントを通して同期されたコンテンツに含まれています。 |
|
isInTrash |
アイテムは現在、ごみ箱の中にあります。 |
ユーザー変数
次の変数は現行のユーザーまたはセッション(あるいはその両方)に関連します。
| 変数 | 説明 |
|---|---|
|
id |
ユーザーのGUID |
|
name |
ユーザーの名前 |
|
loginname |
ユーザーのログイン名 |
|
|
ユーザーの電子メール・アドレス |
|
timezone |
ユーザーのタイムゾーン |
|
ismember |
ユーザーがパブリック・リンクまたはアプリケーション・リンクを介してアイテムにアクセスしていない場合は |
|
ispubliclink |
ユーザーがパブリック・リンクを介してアイテムにアクセスしている場合は |
|
isapplink |
ユーザーがアプリケーション・リンクを介してアイテムにアクセスしている場合は |
|
role |
アイテムに対する現行ユーザーのロール |
|
hasprivilegesas |
ユーザーが指定されたロールを持っているかどうか判断するため、ユーザー・ロールを文字列引数として使用して指定されます |
API関数
次のユーティリティ関数をevaluateまたはinvoke式とともに使用して、指定したアイテムに関する情報を返します。
| 変数 | 説明 |
|---|---|
|
isReservedByAnotherUser(item) |
アイテムが別のユーザーによって予約されている場合は |
|
hasPrivilegesAs(item, role) |
ユーザーがアイテムのロール権限を持っている場合は |
|
getUserRole(item) |
アイテムに対するユーザーのロールを返します |