Replace all the documents and the cover of an album

Namespace:  IpernityNET.IpernityObjects
Assembly:  IpernityNET (in IpernityNET.dll) Version: 0.3.1.0 (0.3.1.0)

Syntax

C#
public DocumentAddResult DocsSetList(
	IEnumerable<int> docIds,
	int coverId
)
Visual Basic (Declaration)
Public Function DocsSetList ( _
	docIds As IEnumerable(Of Integer), _
	coverId As Integer _
) As DocumentAddResult
Visual C++
public:
DocumentAddResult^ DocsSetList(
	IEnumerable<int>^ docIds, 
	int coverId
)

Parameters

docIds
Type: System.Collections.Generic..::.IEnumerable<(Of <(Int32>)>)
A list of document IDs. This list of documents will replace the album existing list. Document will appear in the album the order sent.
coverId
Type: System..::.Int32
The document ID to use as the album cover. This document must belong to the doc_ids list.

Return Value

A DocumentAddResult containing the results

Remarks

This method encapsulates album.docs.setList This method requires "write" permission on docs.

Exceptions

ExceptionCondition
IpernityNET..::.IpernityExceptionThrowed when Ipernity returned an error
IpernityNET.IpernityObjects..::.ObjectNotConfiguredExceptionThrowed when an Ipernity object has not been configured.

See Also