Get Started Contact sales

GooglePlacesSwift Framework Reference

  • The Review struct encapsulates information about a Google Places review, including its rating, text, author attribution, and publish date.

  • It conforms to CustomStringConvertible, Equatable, and Hashable protocols for easier manipulation and comparison.

  • Review provides properties for accessing the review's content in its original and localized forms, along with associated language codes.

  • It includes a relativePublishDateDescription for displaying the review's age in a user-friendly format.

  • Developers can instantiate a Review with detailed information about the review's attributes, such as publish date, rating, and author attribution.

Review

struct Review
 
extension Review : Copyable, CustomStringConvertible, Equatable, Escapable, Hashable, Sendable

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: Review, rhs: Review) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • The attribution that must be shown to the user if this review is displayed.

    See Other Attribution Requirements for more details.

    Declaration

    Swift

    var authorAttribution: AuthorAttribution? { get }

  • A textual representation of this instance.

    Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(describing:) initializer. This initializer works with any type, and uses the custom description property for types that conform to CustomStringConvertible:

    struct Point: CustomStringConvertible {
    let x: Int, y: Int

    var description: String {
        return "(\(x), \(y))"
    }
}

let p = Point(x: 21, y: 30)
let s = String(describing: p)
print(s)
// Prints "(21, 30)"

    The conversion of p to a string in the assignment to s uses the Point type’s description property.

    Declaration

    Swift

    var description: String { get }

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • The hash value.

    Hash values are not guaranteed to be equal across different executions of your program. Do not save hash values to use during a future execution.

    Important

    hashValue is deprecated as a Hashable requirement. To conform to Hashable, implement the hash(into:) requirement instead. The compiler provides an implementation for hashValue for you.

    Declaration

    Swift

    var hashValue: Int { get }

  • Instantiates a Review with detail properties.

    Parameters:

    • publishDate: The Date the review was published.
    • relativePublishTimeDescription: The description of the publish time relative to the time of the request.
    • text: The localized text of the review.
    • textLanguageCode: The language code of the localized review text.
    • originalText: The review text in its original language.
    • originalTextLanguageCode: The language code the review was originally written in.
    • rating: The 0.0 - 5.0 rating associated with the review.
    • authorAttribution: The AuthorAttribution of the review’s author.
    • visitYear: The year user visited the place.
    • visitMonth: The month user visited the place.

    Declaration

    Swift

    init(publishDate: Date, rating: Float, relativePublishDateDescription: String? = nil, text: String? = nil, textLanguageCode: String? = nil, originalText: String? = nil, originalTextLanguageCode: String? = nil, authorAttribution: AuthorAttribution? = nil, visitYear: UInt = 0, visitMonth: UInt = 0)

    Parameters

    publishDate

    The Date the review was published.
    rating

    The 0.0 - 5.0 rating associated with the review.
    text

    The localized text of the review.
    textLanguageCode

    The language code of the localized review text.
    originalText

    The review text in its original language.
    originalTextLanguageCode

    The language code the review was originally written in.
    authorAttribution

    The AuthorAttribution of the review’s author.
    visitYear

    The year user visited the place.
    visitMonth

    The month user visited the place.

  • The text of the review in its original language.

    Declaration

    Swift

    var originalText: String? { get }

  • The language code of the original text of the review.

    Declaration

    Swift

    var originalTextLanguageCode: String? { get }

  • The Date the review was published.

    Declaration

    Swift

    var publishDate: Date { get }

  • A whole number between 1.0 and 5.0, a.k.a. the number of stars.

    Declaration

    Swift

    var rating: Float { get }

  • A formatted string expressing the review date/time relative to the current time. Specific to the language and country (e.g. “6 months ago”).

    Declaration

    Swift

    var relativePublishDateDescription: String? { get }

  • The text of the review.

    Declaration

    Swift

    var text: String? { get }

  • The language code of the text of the review.

    Declaration

    Swift

    var textLanguageCode: String? { get }

  • The month user visited the place. 1-based, 1 is January and 12 is December. 0 is unset.

    Declaration

    Swift

    var visitMonth: UInt { get }

  • The year user visited the place. 0 is unset.

    Declaration

    Swift

    var visitYear: UInt { get }