C# Class Net.Pokeshot.JiveSdk.Clients.DeletedObjectsClient

Inheritance: JiveClient
Mostrar archivo Open project: jivesoftware/JiveDotNetSDK

Private Properties

Property Type Description

Public Methods

Method Description
DeletedObjectsClient ( string communityUrl, NetworkCredential credentials ) : System
GetDeletedContents ( System.DateTime since = null, List types = null, string sort = "eventDateDesc", int startIndex, int count = 25, List fields = null ) : List

Return a list of entities, each representing a content object that has been deleted.

GetDeletedObject ( string deletedObjectId, List fields = null ) : DeletedObject

Return the specified deleted object entity with the specified fields.

GetDeletedPeople ( System.DateTime since = null, List types = null, string sort = "eventDateDesc", int startIndex, int count = 25, List fields = null ) : List

Return a paginated list of entities, each representing a person object that has been deleted.

GetDeletedPlaces ( System.DateTime since = null, List types = null, string sort = "eventDateDesc", int startIndex, int count = 25, List fields = null ) : List

Return a paginated list of entities, each representing a place object that has been deleted.

Method Details

DeletedObjectsClient() public method

public DeletedObjectsClient ( string communityUrl, NetworkCredential credentials ) : System
communityUrl string
credentials System.Net.NetworkCredential
return System

GetDeletedContents() public method

Return a list of entities, each representing a content object that has been deleted.
public GetDeletedContents ( System.DateTime since = null, List types = null, string sort = "eventDateDesc", int startIndex, int count = 25, List fields = null ) : List
since System.DateTime Restricts results to contain entities representing deleted objects removed on or after this date.
types List One or more content object types (discussion, post, file, ...).
sort string Sort order; default returns the most recently deleted objects first. /// eventDateAsc - Sort by the date the content object was removed, in ascending order. /// eventDateDesc - Sort by the date the content object was removed, in descending order. Default if none was specified.
startIndex int Zero-relative index of the first entity to be returned.
count int Maximum number of entities to be returned from Jive at a time.
fields List Fields to be returned in the selected entities.
return List

GetDeletedObject() public method

Return the specified deleted object entity with the specified fields.
public GetDeletedObject ( string deletedObjectId, List fields = null ) : DeletedObject
deletedObjectId string UUID of the deleted object entity to be returned
fields List Fields to be returned
return Net.Pokeshot.JiveSdk.Models.DeletedObject

GetDeletedPeople() public method

Return a paginated list of entities, each representing a person object that has been deleted.
public GetDeletedPeople ( System.DateTime since = null, List types = null, string sort = "eventDateDesc", int startIndex, int count = 25, List fields = null ) : List
since System.DateTime Restricts results to contain entities representing deleted objects removed on or after this date.
types List One or more content object types (discussion, post, file, ...).
sort string Sort order; default returns the most recently deleted objects first. /// eventDateAsc - Sort by the date the content object was removed, in ascending order. /// eventDateDesc - Sort by the date the content object was removed, in descending order. Default if none was specified.
startIndex int Zero-relative index of the first entity to be returned.
count int Maximum number of entities to be returned from Jive at a time.
fields List Fields to be returned in the selected entities.
return List

GetDeletedPlaces() public method

Return a paginated list of entities, each representing a place object that has been deleted.
public GetDeletedPlaces ( System.DateTime since = null, List types = null, string sort = "eventDateDesc", int startIndex, int count = 25, List fields = null ) : List
since System.DateTime Restricts results to contain entities representing deleted objects removed on or after this date.
types List One or more content object types (discussion, post, file, ...).
sort string Sort order; default returns the most recently deleted objects first. /// eventDateAsc - Sort by the date the content object was removed, in ascending order. /// eventDateDesc - Sort by the date the content object was removed, in descending order. Default if none was specified.
startIndex int Zero-relative index of the first entity to be returned.
count int Maximum number of entities to be returned from Jive at a time.
fields List Fields to be returned in the selected entities.
return List