/**
* as_review_get_version:
* @review: a #AsReview
*
* Gets the version string for the application being reviewed..
*
* Returns: the version string, e.g. "0.1.2", or %NULL for unset
*
* Since: 0.6.1
**/
const gchar *
as_review_get_version (AsReview *review)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_val_if_fail (AS_IS_REVIEW (review), NULL);
return priv->version;
}
/**
* as_review_get_date:
* @review: a #AsReview
*
* Gets the date the review was originally submitted.
*
* Returns: (transfer none): the #GDateTime, or %NULL for unset
*
* Since: 0.6.1
**/
GDateTime *
as_review_get_date (AsReview *review)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_val_if_fail (AS_IS_REVIEW (review), NULL);
return priv->date;
}
/**
* as_review_set_reviewer_name:
* @review: a #AsReview
* @reviewer_name: the reviewer name, e.g. "David Smith"
*
* Sets the name of the reviewer, which can be left unset.
*
* Since: 0.6.1
**/
void
as_review_set_reviewer_name (AsReview *review, const gchar *reviewer_name)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_if_fail (AS_IS_REVIEW (review));
as_ref_string_assign_safe (&priv->reviewer_name, reviewer_name);
}
/**
* as_review_set_version:
* @review: a #AsReview
* @version: a version string, e.g. "0.1.2"
*
* Sets the version string for the application being reviewed.
*
* Since: 0.6.1
**/
void
as_review_set_version (AsReview *review, const gchar *version)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_if_fail (AS_IS_REVIEW (review));
as_ref_string_assign_safe (&priv->version, version);
}
/**
* as_review_get_flags:
* @review: a #AsReview
*
* Gets any flags set on the review, for example if the user has already
* voted on the review or if the user wrote the review themselves.
*
* Returns: a #AsReviewFlags, e.g. %AS_REVIEW_FLAG_SELF
*
* Since: 0.6.1
**/
AsReviewFlags
as_review_get_flags (AsReview *review)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_val_if_fail (AS_IS_REVIEW (review), 0);
return priv->flags;
}
/**
* as_review_add_flags:
* @review: a #AsReview
* @flags: a #AsReviewFlags, e.g. %AS_REVIEW_FLAG_SELF
*
* Adds flags to an existing review without replacing the other flags.
*
* Since: 0.6.1
**/
void
as_review_add_flags (AsReview *review, AsReviewFlags flags)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_if_fail (AS_IS_REVIEW (review));
priv->flags |= flags;
}
/**
* as_review_get_rating:
* @review: a #AsReview
*
* Gets the star rating of the review, where 100 is 5 stars.
*
* Returns: integer as a percentage, or 0 for unset
*
* Since: 0.6.1
**/
gint
as_review_get_rating (AsReview *review)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_val_if_fail (AS_IS_REVIEW (review), 0);
return priv->rating;
}
/**
* as_review_set_rating:
* @review: a #AsReview
* @rating: a integer as a percentage, or 0 for unset
*
* Sets the star rating of the review, where 100 is 5 stars..
*
* Since: 0.6.1
**/
void
as_review_set_rating (AsReview *review, gint rating)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_if_fail (AS_IS_REVIEW (review));
priv->rating = rating;
}
/**
* as_review_set_summary:
* @review: a #AsReview
* @summary: a one-line summary, e.g. "Awesome application"
*
* Sets the one-line summary that may be displayed in bold.
*
* Since: 0.6.1
**/
void
as_review_set_summary (AsReview *review, const gchar *summary)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_if_fail (AS_IS_REVIEW (review));
as_ref_string_assign_safe (&priv->summary, summary);
}
/**
* as_review_set_id:
* @review: a #AsReview
* @id: review identifier, e.g. "deadbeef"
*
* Sets the review identifier that is unique to each review.
*
* Since: 0.6.1
**/
void
as_review_set_id (AsReview *review, const gchar *id)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_if_fail (AS_IS_REVIEW (review));
as_ref_string_assign_safe (&priv->id, id);
}
/**
* as_review_set_priority:
* @review: a #AsReview
* @priority: a priority value
*
* Sets the priority for the review, where positive numbers indicate
* a better review for the specific user.
*
* Since: 0.6.1
**/
void
as_review_set_priority (AsReview *review, gint priority)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_if_fail (AS_IS_REVIEW (review));
priv->priority = priority;
}
/**
* as_review_get_priority:
* @review: a #AsReview
*
* This allows the UI to sort reviews into the correct order.
* Higher numbers indicate a more important or relevant review.
*
* Returns: the review priority, or 0 for unset.
*
* Since: 0.6.1
**/
gint
as_review_get_priority (AsReview *review)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_val_if_fail (AS_IS_REVIEW (review), 0);
return priv->priority;
}
/**
* gs_review_row_new:
* @review: The review to show
*
* Create a widget suitable for showing an application review.
*
* Return value: A new @GsReviewRow.
**/
GtkWidget *
gs_review_row_new (AsReview *review)
{
GsReviewRow *row;
GsReviewRowPrivate *priv;
g_return_val_if_fail (AS_IS_REVIEW (review), NULL);
row = g_object_new (GS_TYPE_REVIEW_ROW, NULL);
priv = gs_review_row_get_instance_private (row);
priv->review = g_object_ref (review);
g_signal_connect_object (priv->review, "notify::state",
G_CALLBACK (gs_review_row_notify_props_changed_cb),
row, 0);
g_signal_connect_object (priv->button_yes, "clicked",
G_CALLBACK (gs_review_row_button_clicked_upvote_cb),
row, 0);
g_signal_connect_object (priv->button_no, "clicked",
G_CALLBACK (gs_review_row_button_clicked_downvote_cb),
row, 0);
g_signal_connect_object (priv->button_dismiss, "clicked",
G_CALLBACK (gs_review_row_button_clicked_dismiss_cb),
row, 0);
g_signal_connect_object (priv->button_report, "clicked",
G_CALLBACK (gs_review_row_button_clicked_report_cb),
row, 0);
g_signal_connect_object (priv->button_remove, "clicked",
G_CALLBACK (gs_review_row_button_clicked_remove_cb),
row, 0);
gs_review_row_refresh (row);
return GTK_WIDGET (row);
}
/**
* as_review_get_metadata_item:
* @review: a #AsReview
* @key: a string
*
* Gets some metadata from a review object.
* It is left for the the plugin to use this method as required, but a
* typical use would be to retrieve some secure authentication token.
*
* Returns: A string value, or %NULL for not found
*
* Since: 0.6.1
**/
const gchar *
as_review_get_metadata_item (AsReview *review, const gchar *key)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_val_if_fail (AS_IS_REVIEW (review), NULL);
g_return_val_if_fail (key != NULL, NULL);
return g_hash_table_lookup (priv->metadata, key);
}
/**
* as_review_add_metadata:
* @review: a #AsReview
* @key: a string
* @value: a string
*
* Adds metadata to the review object.
* It is left for the the plugin to use this method as required, but a
* typical use would be to store some secure authentication token.
*
* Since: 0.6.1
**/
void
as_review_add_metadata (AsReview *review, const gchar *key, const gchar *value)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_if_fail (AS_IS_REVIEW (review));
g_hash_table_insert (priv->metadata,
as_ref_string_new (key),
as_ref_string_new (value));
}
/**
* as_review_set_date:
* @review: a #AsReview
* @date: a #GDateTime, or %NULL
*
* Sets the date the review was originally submitted.
*
* Since: 0.6.1
**/
void
as_review_set_date (AsReview *review, GDateTime *date)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
g_return_if_fail (AS_IS_REVIEW (review));
g_clear_pointer (&priv->date, g_date_time_unref);
if (date != NULL)
priv->date = g_date_time_ref (date);
}
