Destination

@objc
public class Destination : NSObject, Decodable
extension Destination: JsonString

A Destination is a physical location your customers arrive at to collect their mobile order – this is usually your store or restaurant. Also known as Stores within Canvas

  • The destination id is used to identify the destination. This is used to trigger Tempo, send Wave events and link Zones to a destination.

    Declaration

    Swift

    @objc
public let destinationId: String

  • The name of the destination.

    Declaration

    Swift

    @objc
public let name: String?

  • The address of the destination.

    Declaration

    Swift

    @objc
public let address: String?

  • A BDPoint that stores spatial geographic information (i.e longitude, latitude) of the destination

    Declaration

    Swift

    @objc
public let location: BDPoint

  • Custom data for the destination, represented as string key–value pairs. Also referred to as Store Custom Data in Canvas.

    Declaration

    Swift

    @objc
public let customData: NSDictionary?

  • Convert to JSON string

    This function throws an error if JSON encoding process fails

    Declaration

    Swift

    @objc(toJson:)
public func toJson() throws -> String