Get the document context in the group
Namespace:
IpernityNET.IpernityObjectsAssembly: IpernityNET (in IpernityNET.dll) Version: 0.3.1.0 (0.3.1.0)
Syntax
C# |
---|
public DocumentContext DocsGetContext( int docId, int prev, int next, Thumbsize size ) |
Visual Basic (Declaration) |
---|
Public Function DocsGetContext ( _ docId As Integer, _ prev As Integer, _ next As Integer, _ size As Thumbsize _ ) As DocumentContext |
Visual C++ |
---|
public: DocumentContext^ DocsGetContext( int docId, int prev, int next, Thumbsize size ) |
Parameters
- docId
- Type: System..::.Int32
The ID of the document to get the context for. By default 10 previous and 10 next documents are returned.
- prev
- Type: System..::.Int32
Only return some previous (oldest) documents. (Value is from 1 to 50)
- next
- Type: System..::.Int32
Only return some next (newest) documents. (Value is from 1 to 50)
- size
- Type: IpernityNET..::.Thumbsize
Choose your prefered size for thumbnails
Return Value
The DocumentContext for the groupRemarks
This method encapsulates group.docs.getContext
"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 |