ファイルでのコラボレーションのリストを取得します。そのファイルに対するアクセス権限を持つすべてのユーザーを返します。
12345
ファイルを表す一意の識別子。
ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123
の場合、file_id
は123
です。
id,type,name
応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。
1000
1000
返す項目の1ページあたりの最大数。
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。
これを使用するには、usemarker
をtrue
に設定する必要があります。
コラボレーションオブジェクトのコレクションを返します。このファイルを関連するコラボレーションが存在しない場合は、空のコレクションが返されます。
予期しないクライアントエラー。
curl -X GET https://api.box.com/2.0/files/12345/collaborations \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
BoxFile file = new BoxFile(api, "id");
Iterable<BoxCollaboration.Info> collaborations = file.getAllFileCollaborations();
collaborations = client.file(file_id='11111').get_collaborations()
for collab in collaborations
target = collab.accessible_by
print('{0} {1} is collaborated on the file'.format(target.type.capitalize(), target.name))
var fileID = '98765';
client.files.getCollaborations(fileID)
.then(collaborations => {
/* collaborations -> {
total_count: 1,
entries: [
{
type: 'collaboration',
id: '11111',
created_by: {
type: 'user',
id: '22222',
name: 'Example User',
login: 'user@example.com'
},
created_at: '2011-11-29T12:56:35-08:00',
modified_at: '2012-09-11T15:12:32-07:00',
expires_at: null,
status: 'accepted',
accessible_by: {
type: 'user',
id: '33333',
name: 'Collaborator User',
login: 'collaborator@example.com'
},
role: 'editor',
acknowledged_at: '2011-11-29T12:59:40-08:00',
item: null
}
]
}
*/
});
client.files.listCollaborations(forFile: "11111") { result in
switch results {
case let .success(iterator):
for i in 1 ... 10 {
iterator.next { result in
switch result {
case let .success(collaboration):
print("Collaboration created by \(collaboration.createdBy?.name)")
case let .failure(error):
print(error)
}
}
}
case let .failure(error):
print(error)
}
}