Return the list of documents in a group
Namespace:
IpernityNET.IpernityObjectsAssembly: IpernityNET (in IpernityNET.dll) Version: 0.3.1.0 (0.3.1.0)
Syntax
C# |
---|
public IEnumerable<Document> DocsGetList( IEnumerable<ExtraInformation> extra, Thumbsize size, int perPage, int page ) |
Visual Basic (Declaration) |
---|
Public Function DocsGetList ( _ extra As IEnumerable(Of ExtraInformation), _ size As Thumbsize, _ perPage As Integer, _ page As Integer _ ) As IEnumerable(Of Document) |
Visual C++ |
---|
public: IEnumerable<Document^>^ DocsGetList( IEnumerable<ExtraInformation>^ extra, Thumbsize size, int perPage, int page ) |
Parameters
- extra
- Type: System.Collections.Generic..::.IEnumerable<(Of <(ExtraInformation>)>)
A comma seprarated list of extra information to include in each records. Extra values are: owner, dates, geo, medias, original.
- size
- Type: IpernityNET..::.Thumbsize
Choose your prefered size for the thumbnails
- perPage
- Type: System..::.Int32
The number of docs to return on each page. (Default is 100, maximum is 500)
- page
- Type: System..::.Int32
The page of results to return.
Return Value
A list of DocumentRemarks
This method encapsulates group.docs.getList
"read" permission is necessary to access to private docs.
Exceptions
Exception | Condition |
---|---|
IpernityNET..::.IpernityException | Throwed when Ipernity returned an error |
IpernityNET.IpernityObjects..::.ObjectNotConfiguredException | Throwed when an Ipernity object has not been configured. Use the method ConfigureIpernityObject(IpernityObject) to configure the object and allow it to interact with Ipernity |