docs for all the other POCOs

This commit is contained in:
2015-04-09 00:02:44 +02:00
parent f52dbd3eb6
commit 0a18394f46
3 changed files with 71 additions and 1 deletions
+12
View File
@@ -5,14 +5,26 @@ namespace OnePeek.Entities
[XmlRoot("feed")]
public partial class AppPublisher
{
/// <summary>
/// The ID of the publisher.
/// </summary>
public string Id { get; set; }
/// <summary>
/// The URN of the publisher.
/// </summary>
[XmlElement("publisherGuid")]
public string Urn { get; set; }
/// <summary>
/// The name of the publisher (individual or company).
/// </summary>
[XmlElement("publisher")]
public string Name { get; set; }
/// <summary>
/// The URI of the publisher website.
/// </summary>
[XmlElement("publisherUrl")]
public string Uri { get; set; }
}
+8
View File
@@ -5,8 +5,16 @@ namespace OnePeek.Entities
[XmlRoot("feed")]
public partial class AppRating
{
/// <summary>
/// Average rating of the app from 1-10 (can be changed to 1-5 with Configuration.UseFiveStarSystem).
/// Is dependent on the current culture.
/// </summary>
public float AverageRating { get; set; }
/// <summary>
/// Count of all ratings yet.
/// Is dependent on the current culture.
/// </summary>
[XmlElement("userRatingCount")]
public int RatingCount { get; set; }
}
+51 -1
View File
@@ -1,45 +1,95 @@
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
namespace OnePeek.Entities
{
public partial class AppReviews
{
/// <summary>
/// The ID of the review list.
/// </summary>
public string Id { get; set; }
/// <summary>
/// Whether the result contains no results.
/// </summary>
public bool IsEmpty { get; set; }
/// <summary>
/// Last modified date of the resource (by Microsoft).
/// </summary>
public DateTime? StoreDataModifiedDate { get; set; }
/// <summary>
/// The type of the store (WP or Windows 8/10)
/// </summary>
public StoreType StoreType { get; set; }
/// <summary>
/// The culture is relevant for the review results,
/// as they are unique per country
/// </summary>
public StoreCultureType StoreCultureType { get; set; }
/// <summary>
/// How to sort the ratings.
/// shouldn't change when making further requests with a provided marker.
/// </summary>
public StoreReviewSorting Sorting { get; set; }
/// <summary>
/// The marker can be passed in the next request to get the previous page of reviews.
/// </summary>
public string PrevPageMarkerId { get; set; }
/// <summary>
/// The marker can be passed in the next request to get the next page of reviews.
/// </summary>
public string NextPageMarkerId { get; set; }
/// <summary>
/// List of reviews (max. 20 at the moment).
/// </summary>
public IEnumerable<AppReview> Reviews { get; set; }
}
public partial class AppReview
{
/// <summary>
/// The ID of the review.
/// </summary>
public string Id { get; set; }
/// <summary>
/// The date the review was created.
/// </summary>
public DateTime CreatedDate { get; set; }
/// <summary>
/// The author who created the review.
/// </summary>
public string Author { get; set; }
/// <summary>
/// The text the author has written in the review.
/// </summary>
public string Text { get; set; }
/// <summary>
/// The rating for the app from 1-10 (can be changed to 1-5 with Configuration.UseFiveStarSystem).
/// </summary>
public byte Rating { get; set; }
/// <summary>
/// The device model which was used for writing the review (and using the app).
/// </summary>
public string Device { get; set; }
/// <summary>
/// The current app version the reviewer has installed.
/// Caution: This seems to be pretty random sometimes.
/// </summary>
public string AppVersion { get; set; }
}
}