Description Usage Format Details Arguments Methods See Also
TagApi Class
1 |
An object of class R6ClassGenerator
of length 24.
Read more about the Tag API in the Agave Developer's Guide
apiClient
a rAgave::ApiClient instance preconfigured to speak to the Agave Platform.
cache
an rAgave::AgaveCache instance pointing to the persistent auth cache file on disk.
responseType
the default object type methods of this class should return. Valid values are:
raw: the raw JSON string response from the API. You may optionally include
pretty=TRUE
in the method call to receive pretty printed JSON.
list: a standard R list object. This is the default value.
dt: a data table
$addTag()
Creat a new tag
Usage
1 | tag$addTag$listTag(body, naked, )
|
$addTagResource()
Add resources to tag
Usage
1 | tag$addTagResource$listTag(tagId, body, naked, )
|
$clearTagPermissions()
Clear tag permissions
Usage
1 | tag$clearTagPermissions$listTag(tagId, naked, )
|
$clearTagResources()
Clear all tagged resources
Usage
1 | tag$clearTagResources$listTag(tagId, naked, )
|
$deleteTag()
Delete tag
Usage
1 | tag$deleteTag$listTag(tagId, naked, )
|
$deleteTagPermissionForUser()
Remove user tag permission
Usage
1 | tag$deleteTagPermissionForUser$listTag(tagId, username, naked, )
|
$getTagDetails()
Tag Details
Usage
1 2 |
$getTagPermissionForUser()
List tag permissions for a user
Usage
1 | tag$getTagPermissionForUser$listTag(tagId, username, naked, )
|
$getTaggedResource()
Get tagged item details
Usage
1 | tag$getTaggedResource$listTag(tagId, uuid, naked, )
|
$listTagHistory()
Tag history
Usage
1 2 |
$listTagPermissions()
List permissionss set for a given tag id
Usage
1 2 |
$listTagResources()
Tagged items
Usage
1 2 |
$listTags()
Available tags
Usage
1 2 |
$removeTagResource()
Remove resource from tag
Usage
1 | tag$removeTagResource$listTag(tagId, uuid, naked, )
|
$updateTag()
Update tag
Usage
1 | tag$updateTag$listTag(tagId, body, naked, )
|
$updateTagPermission()
Grant permission
Usage
1 | tag$updateTagPermission$listTag(tagId, body, naked, )
|
$updateTagPermissionForUser()
Update user permission on tag
Usage
1 | tag$updateTagPermissionForUser$listTag(tagId, username, body, naked, )
|
$updateTagResource()
Add resource to tag
Usage
1 | tag$updateTagResource$listTag(tagId, uuid, body, naked, )
|
rAgave::ApiClient rAgave::Agave [rAgave::Permission][rAgave::Tag][rAgave::TagHistory][rAgave::TagResource][rAgave::TagSummary]
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.