C# Class PodioAPI.Services.RatingService

Mostra file Open project: podio/podio-dotnet

Public Methods

Method	Description
AddRating ( string refType, int refId, string ratingType, int value ) : Task	Add a new rating of the user to the object. The rating can be one of many different types. For more details see the area. Podio API Reference: https://developers.podio.com/doc/ratings/add-rating-22377
GetAllRatings ( string refType, int refId ) : Task	Returns all the ratings for the given object. It will only return the ratings that are enabled for the object. Podio API Reference: https://developers.podio.com/doc/ratings/get-all-ratings-22376
GetLikeCount ( string refType, int refId ) : Task	Get the number of users who liked the given object. Podio API Reference: https://developers.podio.com/doc/ratings/get-like-count-32161225
GetRating ( string refType, int refId, string ratingType, int userId ) : Task	Returns the rating value for the given rating type, object and user. Podio API Reference: https://developers.podio.com/doc/ratings/get-rating-22407
GetRatingOwn ( string refType, int refId, string ratingType ) : Task	Returns the active users rating value for the given rating type and object. Podio API Reference: https://developers.podio.com/doc/ratings/get-rating-own-84128
GetRatings ( string refType, int refId, string ratingType ) : Task	Get the rating average (for fivestar) and totals for the given rating type on the specified object. Podio API Reference: https://developers.podio.com/doc/ratings/get-ratings-22375
GetWhoLikedAnObject ( string refType, int refId, int limit = 10 ) : Task>	Get a list of profiles of everyone that liked the given object. Podio API Reference: https://developers.podio.com/doc/ratings/get-who-liked-an-object-29007011
RatingService ( Podio currentInstance ) : System.Collections.Generic
RemoveRating ( string refType, int refId, string ratingType ) : Task	Removes a previous rating of the given type by the user of the specified object. Podio API Reference: https://developers.podio.com/doc/ratings/remove-rating-22342

Method Details

AddRating() public method

Add a new rating of the user to the object. The rating can be one of many different types. For more details see the area.

Podio API Reference: https://developers.podio.com/doc/ratings/add-rating-22377

public AddRating ( string refType, int refId, string ratingType, int value ) : Task
refType	string
refId	int
ratingType	string
value	int	The value of the rating, see the area for information on the value to use.
return	Task

GetAllRatings() public method

Returns all the ratings for the given object. It will only return the ratings that are enabled for the object.

Podio API Reference: https://developers.podio.com/doc/ratings/get-all-ratings-22376

public GetAllRatings ( string refType, int refId ) : Task
refType	string
refId	int
return	Task

GetLikeCount() public method

Get the number of users who liked the given object.

Podio API Reference: https://developers.podio.com/doc/ratings/get-like-count-32161225

public GetLikeCount ( string refType, int refId ) : Task
refType	string
refId	int
return	Task

GetRating() public method

Returns the rating value for the given rating type, object and user.

Podio API Reference: https://developers.podio.com/doc/ratings/get-rating-22407

public GetRating ( string refType, int refId, string ratingType, int userId ) : Task
refType	string
refId	int
ratingType	string
userId	int
return	Task

GetRatingOwn() public method

Returns the active users rating value for the given rating type and object.

Podio API Reference: https://developers.podio.com/doc/ratings/get-rating-own-84128

public GetRatingOwn ( string refType, int refId, string ratingType ) : Task
refType	string
refId	int
ratingType	string
return	Task

GetRatings() public method

Get the rating average (for fivestar) and totals for the given rating type on the specified object.

Podio API Reference: https://developers.podio.com/doc/ratings/get-ratings-22375

public GetRatings ( string refType, int refId, string ratingType ) : Task
refType	string
refId	int
ratingType	string
return	Task

GetWhoLikedAnObject() public method

Get a list of profiles of everyone that liked the given object.

Podio API Reference: https://developers.podio.com/doc/ratings/get-who-liked-an-object-29007011

public GetWhoLikedAnObject ( string refType, int refId, int limit = 10 ) : Task>
refType	string
refId	int
limit	int	How many profiles that liked something to return. Default value: 10
return	Task>

RatingService() public method

public RatingService ( Podio currentInstance ) : System.Collections.Generic
currentInstance	Podio
return	System.Collections.Generic

RemoveRating() public method

Removes a previous rating of the given type by the user of the specified object.

Podio API Reference: https://developers.podio.com/doc/ratings/remove-rating-22342

public RemoveRating ( string refType, int refId, string ratingType ) : Task
refType	string
refId	int
ratingType	string
return	Task