Interface IRatingRequestFactory
Namespace: EPiServer.Social.Ratings.Rest.Contracts
Assembly: EPiServer.Social.Ratings.Rest.Contracts.dll
Version: 1.5.4Syntax
public interface IRatingRequestFactoryMethods
Add(AddRequest)
Generates an HttpRequestMessage instance for adding ratings.
Declaration
HttpRequestMessage Add(AddRequest addRequest)Parameters
| Type | Name | Description |
|---|---|---|
| AddRequest | addRequest |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage |
Get(String, String)
Generates an HttpRequestMessage instance for retrieving a rating by its identifier.
Declaration
HttpRequestMessage Get(string id, string extensionType = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of the rating to retreive |
| System.String | extensionType |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage |
GetByCriteria(GetByCriteriaRequest)
Generates an HttpRequestMessage instance for retrieving ratings by criteria.
Declaration
HttpRequestMessage GetByCriteria(GetByCriteriaRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| GetByCriteriaRequest | request | An instance of GetByCriteriaRequest containing the criteria to filter ratings by |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage |
GetStatisticsByCriteria(GetStatisticsByCriteriaRequest)
Generates an HttpRequestMessage instance for retrieving rating statistics by criteria.
Declaration
[Obsolete("This API is deprecated. Please use: RatingStatisticsRequestFactory:GetStatisticsByCriteria(GetStatisticsByCriteriaRequest request)")]
HttpRequestMessage GetStatisticsByCriteria(GetStatisticsByCriteriaRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| GetStatisticsByCriteriaRequest | request | An instance of GetStatisticsByCriteriaRequest containing the criteria to filter ratings statisticsby |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage |
Remove(String)
Generates an HttpRequestMessage instance for deleting a rating by its identifier.
Declaration
HttpRequestMessage Remove(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of the rating to remove |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage |
Update(String, UpdateRequest)
Generates an HttpRequestMessage instance for updating ratings.
Declaration
HttpRequestMessage Update(string id, UpdateRequest updateRequest)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of the rating to update |
| UpdateRequest | updateRequest | Values of the rating to update |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage |