Class UserCollectionApi

java.lang.Object

com.amilesend.discogs.api.ApiBase

com.amilesend.discogs.api.UserCollectionApi

public class UserCollectionApi
extends ApiBase

The Discogs User Collection API.
API Documentation

See Also:

• ApiBase

Constructor Summary

Constructors

Constructor	Description
UserCollectionApi(DiscogsConnection connection)	Creates a new UserCollectionApi object.

Method Summary

Modifier and Type	Method	Description
AddToFolderResponse	addToFolder(@NonNull AddToFolderRequest request)	Adds a release to a user's collection folder.
void	changeReleaseRating(@NonNull ChangeReleaseRatingRequest request)	Changes the release rating.
CreateFolderResponse	createFolder(@NonNull CreateFolderRequest request)	Creates a new folder within a user's collection.
void	deleteFolder(@NonNull DeleteFolderRequest request)	Deletes a folder from a user's collection.
void	deleteInstance(@NonNull DeleteInstanceRequest request)	Deletes an instance from a folder.
void	editInstanceField(@NonNull EditInstanceFieldRequest request)	Edits a field for an instance.
GetCollectionItemsByFolderResponse	getCollectionItems(@NonNull GetCollectionItemsByFolderRequest request)	Gets a paginated list of items in a user collection folder.
GetCollectionItemsByReleaseResponse	getCollectionItems(@NonNull GetCollectionItemsByReleaseRequest request)	Gets the paginated list of user collection items by release.
GetCollectionValueResponse	getCollectionValue(@NonNull GetCollectionValueRequest request)	Gets the value of a user's collection.
GetCustomFieldsResponse	getCustomFields(@NonNull GetCustomFieldsRequest request)	Gets the list of custom fields for a user.
GetFolderResponse	getFolder(@NonNull GetFolderRequest request)	Gets a folder from a user's collection.
GetFoldersResponse	getFolders(@NonNull GetFoldersRequest request)	Gets the list of a folders in a user's collection.
void	moveRelease(@NonNull MoveReleaseRequest request)	Moves an instance to another folder.
RenameFolderResponse	renameFolder(@NonNull RenameFolderRequest request)	Renames a folder within a user's collection.

Methods inherited from class ApiBase

getConnection

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserCollectionApi

public UserCollectionApi(DiscogsConnection connection)

Creates a new UserCollectionApi object.

Parameters:

connection - the underlying client connection

Method Details

getFolders

public GetFoldersResponse getFolders(@NonNull GetFoldersRequest request)

Gets the list of a folders in a user's collection. Note: Authentication is optional. Non-authenticated requests will only be able to see a user's "All" folder (i.e., the user's public collection).

Parameters:

request - the request

Returns:

the response

See Also:

• GetFoldersRequest
• GetFoldersResponse

createFolder

public CreateFolderResponse createFolder(@NonNull CreateFolderRequest request)

Creates a new folder within a user's collection.

Parameters:

request - the request

Returns:

the response

See Also:

• CreateFolderRequest
• CreateFolderResponse

getFolder

public GetFolderResponse getFolder(@NonNull GetFolderRequest request)

Gets a folder from a user's collection. Note: Authentication is optional. If GetFolderRequest.getFolderId() is not 0, then user authentication is required.

Parameters:

request - the request

Returns:

the response

See Also:

• GetFolderRequest
• GetFolderResponse

renameFolder

public RenameFolderResponse renameFolder(@NonNull RenameFolderRequest request)

Renames a folder within a user's collection. Note: Authentication is required.

Parameters:

request - the request

Returns:

the response

See Also:

• RenameFolderRequest
• RenameFolderResponse

deleteFolder

public void deleteFolder(@NonNull DeleteFolderRequest request)

Deletes a folder from a user's collection. Note: Authentication is required.

Parameters:

request - the request

See Also:

• DeleteFolderRequest

getCollectionItems

public GetCollectionItemsByReleaseResponse getCollectionItems(@NonNull GetCollectionItemsByReleaseRequest request)

Gets the paginated list of user collection items by release. Note: Authentication is required is the owner's collection is private.

Parameters:

request - the request

Returns:

the response

See Also:

• GetCollectionItemsByReleaseRequest
• GetCollectionItemsByReleaseResponse

getCollectionItems

public GetCollectionItemsByFolderResponse getCollectionItems(@NonNull GetCollectionItemsByFolderRequest request)

Gets a paginated list of items in a user collection folder.

Parameters:

request - the request

Returns:

the response

See Also:

• GetCollectionItemsByFolderRequest
• GetCollectionItemsByFolderResponse

addToFolder

public AddToFolderResponse addToFolder(@NonNull AddToFolderRequest request)

Adds a release to a user's collection folder. Note: Authentication required.

Parameters:

request - the request

Returns:

the response

See Also:

• AddToFolderRequest
• AddToFolderResponse

changeReleaseRating

public void changeReleaseRating(@NonNull ChangeReleaseRatingRequest request)

Changes the release rating.

Parameters:

request - the request

See Also:

• ChangeReleaseRatingRequest

moveRelease

public void moveRelease(@NonNull MoveReleaseRequest request)

Moves an instance to another folder.

Parameters:

request - the request

See Also:

• MoveReleaseRequest

deleteInstance

public void deleteInstance(@NonNull DeleteInstanceRequest request)

Deletes an instance from a folder.

Parameters:

request - the request

See Also:

• DeleteInstanceRequest

getCustomFields

public GetCustomFieldsResponse getCustomFields(@NonNull GetCustomFieldsRequest request)

Gets the list of custom fields for a user. Note: Authentication is optional. If a collection is private, then authentication as the owner is required. Non-authenticated requests can only retrieve fields with public fields.

Parameters:

request - the request

Returns:

the response

See Also:

• GetCustomFieldsRequest
• GetCustomFieldsResponse

editInstanceField

public void editInstanceField(@NonNull EditInstanceFieldRequest request)

Edits a field for an instance.

Parameters:

request - the request

See Also:

• EditInstanceFieldRequest

getCollectionValue

public GetCollectionValueResponse getCollectionValue(@NonNull GetCollectionValueRequest request)

Gets the value of a user's collection. Note: Must be authenticated as the collection owner.

Parameters:

request - the request

Returns:

the response

See Also:

• GetCollectionValueRequest
• GetCollectionValueResponse