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

Can be used to make requests to the Jive /activities endpoint

Inheritance: JiveClient

Show file Open project: jivesoftware/JiveDotNetSDK

Public Methods

Method	Description
ActivitiesClient ( string communityUrl, NetworkCredential credential ) : Net.Pokeshot.JiveSdk.Models	Initializes a new instance of ActivityRetriever
CreateActivity ( Activity activity, List fields = null ) : Activity	Create a new activity stream entry based on the characteristics in the "activity" object. Note: if the published and/or updated fields in the Activity are set, they must be have the time down to the second with the DateTimeKind field set
GetActivities ( System.DateTime time, bool after = true, int count = 25, List filter = null, List fields = null ) : List	Queries Jive's Activities endpoint for all Activities after "time".
GetActivitiesCount ( System.DateTime after, int max = 50, bool exclude = false ) : int	Queries the API for the number of Activities since "after".
GetDiscoveryChannel ( List fields = null ) : List	Return the discovery stream, containing recommended, trending, and matters most items.
GetFrequentContent ( int count = 20, List fields = null, List filter = null, bool abridged = false ) : List	Return the most frequently viewed content that is visible to the requesting person.
GetFrequentPeople ( int count = 20, List fields = null ) : List	Return the most frequently viewed people that are visible to the requesting person.
GetFrequentPlaces ( int count = 20, List fields = null ) : List	Return the most frequently viewed places that are visible to the requesting person.
GetRecentContent ( System.DateTime before, int count = 10, List fields = null, List filter = null, bool abridged = false ) : List	Return the most recently viewed content that is visible to the requesting person.
GetRecentPeople ( int count = 25, List fields = null ) : List	Return the most recently viewed people that are visible to the requesting person.
GetRecentPlaces ( int count = 25, List fields = null ) : List	Return the most recently viewed places that are visible to the requesting person.
GetSocialNews ( System.DateTime before, int count = 5, List fields = null ) : List	Return a paginated list of social news for the authenticated user.
GetSocialPeople ( int count = 25, List fields = null ) : List	Return the people most frequently interacted with in the inbox that are visible to the requesting person.

Method Details

ActivitiesClient() public method

Initializes a new instance of ActivityRetriever

public ActivitiesClient ( string communityUrl, NetworkCredential credential ) : Net.Pokeshot.JiveSdk.Models
communityUrl	string	The url of the targeted Jive community (e.g. https://jivecommunity.jiveon.com)
credential	System.Net.NetworkCredential	The NetworkCredential containing the username and password for a user in the given Jive Community
return	Net.Pokeshot.JiveSdk.Models

CreateActivity() public method

Create a new activity stream entry based on the characteristics in the "activity" object. Note: if the published and/or updated fields in the Activity are set, they must be have the time down to the second with the DateTimeKind field set

public CreateActivity ( Activity activity, List fields = null ) : Activity
activity	Net.Pokeshot.JiveSdk.Models.Activity	an Activity object containing the required data to construct a new activity stream entry
fields	List	Names of the fields to be returned
return	Net.Pokeshot.JiveSdk.Models.Activity

GetActivities() public method

Queries Jive's Activities endpoint for all Activities after "time".

public GetActivities ( System.DateTime time, bool after = true, int count = 25, List filter = null, List fields = null ) : List
time	System.DateTime	The time representing the earliest or lates time to consider (depending on the value of "after").
after	bool	If true, the request will be made for the times after "time". If false, the request is made for times before "time".
count	int	Maximum number of activities to return in this request (you may get more activities than this in order to get all of the activities in the last collection)(max is 1000)
filter	List	Filter expression(s) used to select matching results (e.g. type(likes,social,profiles,endorsements))
fields	List	The fields to be included in returned activities
return	List

GetActivitiesCount() public method

Queries the API for the number of Activities since "after".

public GetActivitiesCount ( System.DateTime after, int max = 50, bool exclude = false ) : int
after	System.DateTime	The oldest date to consider when counting the activities.
max	int	The maximum number of new activity counts to return. Default is 50.
exclude	bool	Flag indicating whether activity performed by the user should be omitted. Default is false.
return	int

GetDiscoveryChannel() public method

Return the discovery stream, containing recommended, trending, and matters most items.

public GetDiscoveryChannel ( List fields = null ) : List
fields	List	Fields to be included in returned place entities
return	List

GetFrequentContent() public method

Return the most frequently viewed content that is visible to the requesting person.

public GetFrequentContent ( int count = 20, List fields = null, List filter = null, bool abridged = false ) : List
count	int	Maximum number of content entities to return in this request (bounded at 20)
fields	List	Fields to be included in returned content entities
filter	List	Filter expression(s) used to select matching results (currently supports type only). Since 3.5.
abridged	bool	Flag indicating that if content.text is requested, it will be abridged (length shortened, HTML tags removed)
return	List

GetFrequentPeople() public method

Return the most frequently viewed people that are visible to the requesting person.

public GetFrequentPeople ( int count = 20, List fields = null ) : List
count	int	Maximum number of person entities to return in this request (bounded at 20)
fields	List	Fields to be included in returned person entities
return	List

GetFrequentPlaces() public method

Return the most frequently viewed places that are visible to the requesting person.

public GetFrequentPlaces ( int count = 20, List fields = null ) : List
count	int	Maximum number of place entities to return in this request (bounded at 20)
fields	List	Fields to be included in returned place entities
return	List

GetRecentContent() public method

Return the most recently viewed content that is visible to the requesting person.

public GetRecentContent ( System.DateTime before, int count = 10, List fields = null, List filter = null, bool abridged = false ) : List
before	System.DateTime	Date and time representing the maximum "last activity" timestamp. Since 3.5.
count	int	Maximum number of content entities to return in this request
fields	List	Fields to be included in returned content entities
filter	List	Filter expression(s) used to select matching results (currently supports type only)
abridged	bool	Flag indicating that if content.text is requested, it will be abridged (length shortened, HTML tags removed)
return	List

GetRecentPeople() public method

Return the most recently viewed people that are visible to the requesting person.

public GetRecentPeople ( int count = 25, List fields = null ) : List
count	int	Maximum number of person entities to return in this request
fields	List	Fields to be included in returned person entities
return	List

GetRecentPlaces() public method

Return the most recently viewed places that are visible to the requesting person.

public GetRecentPlaces ( int count = 25, List fields = null ) : List
count	int	Maximum number of place entities to return in this request
fields	List	Fields to be included in returned place entities
return	List

GetSocialNews() public method

Return a paginated list of social news for the authenticated user.

public GetSocialNews ( System.DateTime before, int count = 5, List fields = null ) : List
before	System.DateTime	Date and time in ISO-8601 format that indicates the maximum date. By default is 'now'
count	int	The maximum number of news to be returned. By default is 5.
fields	List	The fields to be returned on each news
return	List

GetSocialPeople() public method

Return the people most frequently interacted with in the inbox that are visible to the requesting person.

public GetSocialPeople ( int count = 25, List fields = null ) : List
count	int	Maximum number of person entities to return in this request (bounded at 100)
fields	List	Fields to be included in returned person entities
return	List