This provides APIs related to Place Review information, used in Place Discovery and Search.

Functions
int	maps_place_review_destroy (maps_place_review_h review)
	Destroys the place review handle and releases all its resources.
int	maps_place_review_clone (const maps_place_review_h origin, maps_place_review_h *cloned)
	Clones the place review handle.
int	maps_place_review_get_date (const maps_place_review_h review, char **date)
	Gets the place review date.
int	maps_place_review_get_title (const maps_place_review_h review, char **title)
	Gets the place review title.
int	maps_place_review_get_rating (const maps_place_review_h review, double *rating)
	Gets the place review rating.
int	maps_place_review_get_description (const maps_place_review_h review, char **description)
	Gets the place review description.
int	maps_place_review_get_language (const maps_place_review_h review, char **language)
	Gets the place review language.
int	maps_place_review_get_media (const maps_place_review_h review, maps_place_media_h *media)
	Gets the place review media.
int	maps_place_review_get_user_link (const maps_place_review_h review, maps_place_link_object_h *user)
	Gets the place review user link.
Typedefs
typedef void *	maps_place_review_h
	The Place Review handle.

Typedef Documentation

typedef void* maps_place_review_h

The Place Review handle.

The handle of Place Review instance.

Since :: 2.4

Remarks:: To release the handle use maps_place_review_destroy().
To clone the handle use maps_place_review_clone().

See also:: maps_place_review_destroy(); maps_place_review_clone()

Function Documentation

int maps_place_review_clone	(	const maps_place_review_h	origin,
		maps_place_review_h *	cloned
	)

Clones the place review handle.

This function clones the place review handle origin and all its resources.

Since :: 2.4

Remarks:: cloned must be released using maps_place_review_destroy().

Parameters:

[in]	origin	The original place review handle
[out]	cloned	A cloned place review handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_OUT_OF_MEMORY	Out of memory
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

See also:: maps_place_review_destroy()

int maps_place_review_destroy ( maps_place_review_h review )

Destroys the place review handle and releases all its resources.

This function destroys the place review handle and releases all its resources.

Since :: 2.4

Parameters:

[in] review The place review handle to destroy

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

See also:: maps_place_review_clone()

int maps_place_review_get_date	(	const maps_place_review_h	review,
		char **	date
	)

Gets the place review date.

This function gets the place review date.

Since :: 2.4

Remarks:: date must be released using free().

Parameters:

[in]	review	The handle to place review
[out]	date	The place review date

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

int maps_place_review_get_description	(	const maps_place_review_h	review,
		char **	description
	)

Gets the place review description.

This function gets the place review description.

Since :: 2.4

Remarks:: description must be released using free().

Parameters:

[in]	review	The handle to place review
[out]	description	The place review description

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

int maps_place_review_get_language	(	const maps_place_review_h	review,
		char **	language
	)

Gets the place review language.

This function gets the place review language.

Since :: 2.4

Remarks:: language must be released using free().

Parameters:

[in]	review	The handle to place review
[out]	language	The place review language

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

int maps_place_review_get_media	(	const maps_place_review_h	review,
		maps_place_media_h *	media
	)

Gets the place review media.

This function gets the place review media.

Since :: 2.4

Remarks:: media must be released using maps_place_media_destroy().

Parameters:

[in]	review	The handle to place review
[out]	media	The place review media

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

See also:: maps_place_media_h

int maps_place_review_get_rating	(	const maps_place_review_h	review,
		double *	rating
	)

Gets the place review rating.

This function gets the place review rating.

Since :: 2.4

Parameters:

[in]	review	The handle to place review
[out]	rating	The place review rating

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

int maps_place_review_get_title	(	const maps_place_review_h	review,
		char **	title
	)

Gets the place review title.

This function gets the place review title.

Since :: 2.4

Remarks:: title must be released using free().

Parameters:

[in]	review	The handle to place review
[out]	title	The place review title

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

int maps_place_review_get_user_link	(	const maps_place_review_h	review,
		maps_place_link_object_h *	user
	)

Gets the place review user link.

This function gets the place review user link.

Since :: 2.4

Remarks:: user must be released using maps_place_link_object_destroy().

Parameters:

[in]	review	The handle to place review
[out]	user	The place review user link

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

See also:: maps_place_link_object_h

Functions

Typedefs

Typedef Documentation

Function Documentation