Get Started Contact sales

GooglePlacesSwift Framework Reference

  • Photo stores metadata for a single photo associated with a place, including attributions, author information, and maximum size.

  • It conforms to CustomStringConvertible, Equatable, and Hashable for describing, comparing, and uniquely identifying photos.

  • The attributions property provides an attributed string detailing data provider credits, which should be displayed to users.

  • Photos can be instantiated for testing purposes using initializers that accept size, attributions, and author details.

Photo

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

The metadata corresponding to a single photo associated with a place.

  • 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: Photo, rhs: Photo) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • The data provider attribution string for this photo.

    These are provided as a NSAttributedString, which may contain hyperlinks to the website of each provider.

    In general, these must be shown to the user if data from this PlacePhotoMetadata is shown, as described in the Places SDK Terms of Service.

    Declaration

    Swift

    var attributions: AttributedString? { get }

  • Declaration

    Swift

    var authorAttributions: [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 Photo with the specified information.

    Photos can be gotten from a Place object. This initializer can be used for testing.

    Declaration

    Swift

    init(maxSize: CGSize, attributions: AttributedString? = nil, authorAttributions: [AuthorAttribution] = [])

    Parameters

    maxSize

    The maximum pixel size in which this photo is available.
    attributions

    The data provider attribution string for this photo.
    authorAttributions

    The optional author attributions for this photo.

    Return Value

    A Photo containing the specified information.

  • Instantiates a Photo with the specified information.

    Photos can be gotten from a Place object. This initializer can be used for testing.

    Declaration

    Swift

    init(maxSize: CGSize, attributions: NSAttributedString?, authorAttributions: [AuthorAttribution] = [])

    Parameters

    maxSize

    The maximum pixel size in which this photo is available.
    attributions

    The data provider attribution string for this photo.
    authorAttributions

    The optional author attributions for this photo.

    Return Value

    A Photo containing the specified information.

  • The data provider attribution string for this photo.

    These are provided as a NSAttributedString, which may contain hyperlinks to the website of each provider.

    In general, these must be shown to the user if data from this PlacePhotoMetadata is shown, as described in the Places SDK Terms of Service.

    Declaration

    Swift

    var legacyAttributions: NSAttributedString? { get }

  • The maximum pixel size in which this photo is available.

    Declaration

    Swift

    var maxSize: CGSize { get }