UserCollection | discojs

Hierarchy

UserCollection
- Discojs

Index

User Collection Methods

User Folder Methods

User Methods

User Collection Methods

createFolder

createFolder(this: Discojs, name: string): Promise<{} & {}>

- Defined in src/userCollection.ts:51
Create a new folder in authenticated user’s collection.

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection

Parameters
- this: Discojs
- name: string
Returns Promise<{} & {}>

listFolders

listFolders(this: Discojs): Promise<{}>

- Defined in src/userCollection.ts:39
Retrieve a list of folders in authenticated user’s collection.

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection

Parameters
- this: Discojs
Returns Promise<{}>

listFoldersForUser

listFoldersForUser(this: Discojs, username: string): Promise<{}>

- Defined in src/userCollection.ts:28
Retrieve a list of folders in a user’s collection.

remarks

If the collection has been made private by its owner, authentication as the collection owner is required. If you are not authenticated as the collection owner, only folder ID 0 (the “All” folder) will be visible (if the requested user’s collection is public).

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection

Parameters
- this: Discojs
- username: string
Returns Promise<{}>

User Folder Methods

deleteFolder

deleteFolder(this: Discojs, folderId: FolderIdsEnum | number): Promise<EmptyResponse>

- Defined in src/userCollection.ts:109
Delete a folder from a user’s collection.

remarks

A folder must be empty before it can be deleted.

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-folder

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
Returns Promise<EmptyResponse>

editFolder

editFolder(this: Discojs, folderId: FolderIdsEnum | number, name: string): Promise<{} & {}>

- Defined in src/userCollection.ts:92
Edit a folder’s metadata.

remarks

Folders 0 and 1 cannot be renamed.

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-folder

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
- name: string
Returns Promise<{} & {}>

getFolder

getFolder(this: Discojs, folderId: FolderIdsEnum | number): Promise<{} & {}>

- Defined in src/userCollection.ts:77
Retrieve metadata about a folder in authenticated user’s collection.

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-folder

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
Returns Promise<{} & {}>

getFolderForUser

getFolderForUser(this: Discojs, username: string, folderId: FolderIdsEnum | number): Promise<{} & {}>

- Defined in src/userCollection.ts:66
Retrieve metadata about a folder in a user’s collection.

remarks

If folder_id is not 0, authentication as the collection owner is required.

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-folder

Parameters
- this: Discojs
- username: string
- folderId: FolderIdsEnum | number
Returns Promise<{} & {}>

User Methods

addReleaseToFolder

addReleaseToFolder(this: Discojs, releaseId: number, folderId?: FolderIdsEnum | number): Promise<{} & {}>

- Defined in src/userCollection.ts:200
Add a release to a folder in authenticated user’s collection.

label

Add To Collection Folder

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-add-to-collection-folder

Parameters
- this: Discojs
- releaseId: number
- Default value folderId: FolderIdsEnum | number = FolderIdsEnum.UNCATEGORIZED
Returns Promise<{} & {}>

deleteReleaseInstanceFromFolder

deleteReleaseInstanceFromFolder(this: Discojs, folderId: FolderIdsEnum | number, releaseId: number, instanceId: number): Promise<EmptyResponse>

- Defined in src/userCollection.ts:269
Remove an instance of a release from authenticated user’s collection folder.

label

Delete Instance From Folder

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-delete-instance-from-folder

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
- releaseId: number
- instanceId: number
Returns Promise<EmptyResponse>

editCustomFieldForInstance

editCustomFieldForInstance(this: Discojs, folderId: FolderIdsEnum | number, releaseId: number, instanceId: number, fieldId: number, value: string): Promise<EmptyResponse>

- Defined in src/userCollection.ts:320
Change the value of a notes field on a particular instance.

label

Edit Fields Instance

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-edit-fields-instance

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
- releaseId: number
- instanceId: number
- fieldId: number
- value: string
Returns Promise<EmptyResponse>

editReleaseInstanceRating

editReleaseInstanceRating(this: Discojs, folderId: FolderIdsEnum | number, releaseId: number, instanceId: number, rating: RatingValues): Promise<EmptyResponse>

- Defined in src/userCollection.ts:221
Change the rating on a release.

label

Change Rating Of Release

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-change-rating-of-release

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
- releaseId: number
- instanceId: number
- rating: RatingValues
Returns Promise<EmptyResponse>

getCollectionValue

getCollectionValue(this: Discojs): Promise<{}>

- Defined in src/userCollection.ts:346
Returns the minimum, median, and maximum value of authenticated user’s collection.

requires

authentication

label

Collection Value

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-value

Parameters
- this: Discojs
Returns Promise<{}>

listCustomFields

listCustomFields(this: Discojs): Promise<{}>

- Defined in src/userCollection.ts:307
Retrieve a list of authenticated user-defined collection notes fields. These fields are available on every release in the collection.

label

List Custom Fields

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-list-custom-fields

Parameters
- this: Discojs
Returns Promise<{}>

listCustomFieldsForUser

listCustomFieldsForUser(this: Discojs, username: string): Promise<{}>

- Defined in src/userCollection.ts:295
Retrieve a list of user-defined collection notes fields. These fields are available on every release in the collection.

remarks

If the collection has been made private by its owner, authentication as the collection owner is required. If you are not authenticated as the collection owner, only fields with public set to true will be visible.

label

List Custom Fields

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-list-custom-fields

Parameters
- this: Discojs
- username: string
Returns Promise<{}>

listItemsByRelease

listItemsByRelease(this: Discojs, release_id: number, pagination?: Pagination): Promise<{}>

- Defined in src/userCollection.ts:140
View authenticated user’s collection folders which contain a specified release. This will also show information about each release instance.

label

Items By Release

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-items-by-release

Parameters
- this: Discojs
- release_id: number
- Optional pagination: Pagination
Returns Promise<{}>

listItemsByReleaseForUser

listItemsByReleaseForUser(this: Discojs, username: string, release_id: number, pagination?: Pagination): Promise<{}>

- Defined in src/userCollection.ts:125
View the user’s collection folders which contain a specified release. This will also show information about each release instance.

remarks

Authentication as the collection owner is required if the owner’s collection is private.

label

Items By Release

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-items-by-release

Parameters
- this: Discojs
- username: string
- release_id: number
- Optional pagination: Pagination
Returns Promise<{}>

listItemsInFolder

listItemsInFolder(this: Discojs, folderId: FolderIdsEnum | number, sort?: SortOptions<UserSortEnum>, pagination?: Pagination): Promise<{}>

- Defined in src/userCollection.ts:182
Returns the list of item in a folder in authenticated user’s collection.

remarks

Basic information about each release is provided, suitable for display in a list. For detailed information, make another API call to fetch the corresponding release.

label

Collection Items By Folder

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-items-by-folder

Parameters
- this: Discojs
- folderId: FolderIdsEnum | number
- Optional sort: SortOptions<UserSortEnum>
- Optional pagination: Pagination
Returns Promise<{}>

listItemsInFolderForUser

listItemsInFolderForUser(this: Discojs, username: string, folderId: FolderIdsEnum | number, sort?: SortOptions<UserSortEnum>, pagination?: Pagination): Promise<{}>

- Defined in src/userCollection.ts:158
Returns the list of item in a folder in a user’s collection.

remarks

Basic information about each release is provided, suitable for display in a list. For detailed information, make another API call to fetch the corresponding release. If folder_id is not 0, or the collection has been made private by its owner, authentication as the collection owner is required. If you are not authenticated as the collection owner, only public notes fields will be visible.

label

Collection Items By Folder

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-collection-items-by-folder

Parameters
- this: Discojs
- username: string
- folderId: FolderIdsEnum | number
- Optional sort: SortOptions<UserSortEnum>
- Optional pagination: Pagination
Returns Promise<{}>

moveReleaseInstanceToFolder

moveReleaseInstanceToFolder(this: Discojs, oldFolderId: FolderIdsEnum | number, releaseId: number, instanceId: number, newFolderId: FolderIdsEnum | number): Promise<EmptyResponse>

- Defined in src/userCollection.ts:245
Move the instance of a release to another folder.

label

Change Rating Of Release

link

https://www.discogs.com/developers#page:user-collection,header:user-collection-change-rating-of-release

Parameters
- this: Discojs
- oldFolderId: FolderIdsEnum | number
- releaseId: number
- instanceId: number
- newFolderId: FolderIdsEnum | number
Returns Promise<EmptyResponse>

Generated using TypeDoc

Hierarchy

Index

User Collection Methods

User Folder Methods

User Methods

User Collection Methods

createFolder

Parameters

this: Discojs

name: string

Returns Promise<{} & {}>

listFolders

Parameters

this: Discojs

Returns Promise<{}>

listFoldersForUser

Parameters

this: Discojs

username: string

Returns Promise<{}>

User Folder Methods

deleteFolder

Parameters

this: Discojs

folderId: FolderIdsEnum | number

Returns Promise<EmptyResponse>

editFolder

Parameters

this: Discojs

folderId: FolderIdsEnum | number

name: string

Returns Promise<{} & {}>

getFolder

Parameters

this: Discojs

folderId: FolderIdsEnum | number

Returns Promise<{} & {}>

getFolderForUser

Parameters

this: Discojs

username: string

folderId: FolderIdsEnum | number

Returns Promise<{} & {}>

User Methods

addReleaseToFolder

Parameters

this: Discojs

releaseId: number

Default value folderId: FolderIdsEnum | number = FolderIdsEnum.UNCATEGORIZED

Returns Promise<{} & {}>

deleteReleaseInstanceFromFolder

Parameters

this: Discojs

folderId: FolderIdsEnum | number

releaseId: number

instanceId: number

Returns Promise<EmptyResponse>

editCustomFieldForInstance

Parameters

this: Discojs

folderId: FolderIdsEnum | number

releaseId: number

instanceId: number

fieldId: number

value: string

Returns Promise<EmptyResponse>

editReleaseInstanceRating

Parameters

this: Discojs

folderId: FolderIdsEnum | number

releaseId: number

instanceId: number

rating: RatingValues

Returns Promise<EmptyResponse>

getCollectionValue

Parameters

this: Discojs

Returns Promise<{}>

listCustomFields

Parameters