pub struct CollectionApi<'a> { /* private fields */ }Expand description
Sub-API for collection endpoints.
Implementations§
Source§impl<'a> CollectionApi<'a>
impl<'a> CollectionApi<'a>
Sourcepub async fn get_user_collections(&self) -> Result<Value, RsError>
pub async fn get_user_collections(&self) -> Result<Value, RsError>
Sourcepub async fn add_resource_to_collection(
&self,
request: AddResourceToCollectionRequest,
) -> Result<Value, RsError>
pub async fn add_resource_to_collection( &self, request: AddResourceToCollectionRequest, ) -> Result<Value, RsError>
Add a resource to a collection.
§Arguments
request- Parameters built viaAddResourceToCollectionRequest
§Returns
True or false depending on operation success.
§TODO: Errors
§TODO: Examples
Sourcepub async fn remove_resource_from_collection(
&self,
request: RemoveResourceFromCollectionRequest,
) -> Result<Value, RsError>
pub async fn remove_resource_from_collection( &self, request: RemoveResourceFromCollectionRequest, ) -> Result<Value, RsError>
Remove a resource from a collection.
§Arguments
request- Parameters built viaRemoveResourceFromCollectionRequest
§Returns
True or false depending on operation success.
§TODO: Errors
§TODO: Examples
Sourcepub async fn create_collection(
&self,
request: CreateCollectionRequest,
) -> Result<Value, RsError>
pub async fn create_collection( &self, request: CreateCollectionRequest, ) -> Result<Value, RsError>
Create a new collection for the user.
§Arguments
request- Parameters built viaCreateCollectionRequest
§Returns
Integer|bool - ID of the collection created, false if collection creation is not permitted
§TODO: Errors
§TODO: Examples
Sourcepub async fn delete_collection(
&self,
request: DeleteCollectionRequest,
) -> Result<Value, RsError>
pub async fn delete_collection( &self, request: DeleteCollectionRequest, ) -> Result<Value, RsError>
Deletes a collection. The user must have write access to this collection.
§Arguments
request- Parameters built viaDeleteCollectionRequest
§Returns
True or false depending on operation success.
§TODO: Errors
§TODO: Examples
Sourcepub async fn search_public_collections(
&self,
request: SearchPublicCollectionsRequest,
) -> Result<Value, RsError>
pub async fn search_public_collections( &self, request: SearchPublicCollectionsRequest, ) -> Result<Value, RsError>
Search public and featured collections.
§Arguments
request- Parameters built viaSearchPublicCollectionsRequest
§Returns
A list of matching public or featured collections.
§TODO: Errors
§TODO: Examples
Sourcepub async fn get_collection(
&self,
request: GetCollectionRequest,
) -> Result<Value, RsError>
pub async fn get_collection( &self, request: GetCollectionRequest, ) -> Result<Value, RsError>
Get collection details.
This requires administrator access (“a” permission).
§Arguments
request- Parameters built viaGetCollectionRequest
§Returns
The collection details including owner name, description, public/private status, thumbnail image reference. All available columns are returned.
§TODO: Errors
§TODO: Examples
Sourcepub async fn save_collection(
&self,
request: SaveCollectionRequest,
) -> Result<Value, RsError>
pub async fn save_collection( &self, request: SaveCollectionRequest, ) -> Result<Value, RsError>
Save collection data.
§Arguments
request- Parameters built viaSaveCollectionRequest
§Returns
Returns false if access control fails or invalid arguments have been received (e.g ref not a number), true otherwise.
§TODO: Errors
§TODO: Examples
Sourcepub async fn show_hide_collection(
&self,
request: ShowHideCollectionRequest,
) -> Result<Value, RsError>
pub async fn show_hide_collection( &self, request: ShowHideCollectionRequest, ) -> Result<Value, RsError>
Shows or hides a collection from the user’s drop-down list.
§Arguments
request- Parameters built viaShowHideCollectionRequest
§Returns
True or false depending on operation success.
§TODO: Errors
§TODO: Examples
Sourcepub async fn send_collection_to_admin(
&self,
request: SendCollectionToAdminRequest,
) -> Result<Value, RsError>
pub async fn send_collection_to_admin( &self, request: SendCollectionToAdminRequest, ) -> Result<Value, RsError>
Sends a copy of the collection for admin review.
§Arguments
request- Parameters built viaSendCollectionToAdminRequest
§Returns
True or false depending on operation success.
§TODO: Errors
§TODO: Examples
Sourcepub async fn get_featured_collections(
&self,
request: GetFeaturedCollectionsRequest,
) -> Result<Value, RsError>
pub async fn get_featured_collections( &self, request: GetFeaturedCollectionsRequest, ) -> Result<Value, RsError>
Get ResourceSpace featured collections (category).
§Arguments
request- Parameters built viaGetFeaturedCollectionsRequest
§Returns
If successful, a 200 HTTP status will be returned with the body containing an array. If the parent is invalid an empty array will be returned instead.
§TODO: Errors
§TODO: Examples
Sourcepub async fn delete_resources_in_collection(
&self,
request: DeleteResourcesInCollectionRequest,
) -> Result<Value, RsError>
pub async fn delete_resources_in_collection( &self, request: DeleteResourcesInCollectionRequest, ) -> Result<Value, RsError>
Deletes all resources in a collection.
The user must have edit access to the resources, permission to delete resources and the collection must be writable.
§Arguments
request- Parameters built viaDeleteResourcesInCollectionRequest
§Returns
True or false depending on operation success.
§TODO: Errors
§TODO: Examples
Sourcepub async fn get_collections_resource_count(
&self,
request: GetCollectionsResourceCountRequest,
) -> Result<Value, RsError>
pub async fn get_collections_resource_count( &self, request: GetCollectionsResourceCountRequest, ) -> Result<Value, RsError>
Get the total resource count for a list of collections.
Requires permission b and the collections must be readable by the user.
§Arguments
request- Parameters built viaGetCollectionsResourceCountRequest
§Returns
Array of collections and their total resource count. Note the returned array may not contain keys for all input IDs if validation fails for some.