ProximityReader · IOS API REFERENCE

CustomerEngagementSession.Configuration

struct · iOS 27.0+ · SDK 27.1

struct Configuration

A set of configuration options for a customer engagement session.

Members (15)

get · iOS 27.0+

deviceName

TypeScript

get deviceName(): (string) | null

Swift declaration

var deviceName: String?

The device name or sales staff name to identify the merchant device.

set · iOS 27.0+

deviceName

TypeScript

set deviceName(value: (string) | null)

Swift declaration

var deviceName: String?

The device name or sales staff name to identify the merchant device.

get · iOS 27.0+

websiteURL

TypeScript

get websiteURL(): (string) | null

Swift declaration

var websiteURL: URL?

The merchant website URL.

set · iOS 27.0+

websiteURL

TypeScript

set websiteURL(value: (string) | null)

Swift declaration

var websiteURL: URL?

The merchant website URL.

get · iOS 27.0+

privacyPolicyURL

TypeScript

get privacyPolicyURL(): string

Swift declaration

var privacyPolicyURL: URL

A URL for your privacy policy. This is displayed to customers on the brand details screen. This policy should describe the personal information collected during the engagement session.

set · iOS 27.0+

privacyPolicyURL

TypeScript

set privacyPolicyURL(value: string)

Swift declaration

var privacyPolicyURL: URL

A URL for your privacy policy. This is displayed to customers on the brand details screen. This policy should describe the personal information collected during the engagement session.

get · iOS 27.0+

passTypeIdentifiers

TypeScript

get passTypeIdentifiers(): Array<string>

Swift declaration

var passTypeIdentifiers: [String]

An array of pass type identifiers for the your passes. The session queries the Wallet app using this array when you request the pass attribute option in the ``requestCustomerInfo(for:fields:message:)``. The session also validates this array against ``AddPassRequest`` to ensure only the merchant supported passes are added to the Wallet.

set · iOS 27.0+

passTypeIdentifiers

TypeScript

set passTypeIdentifiers(value: Array<string>)

Swift declaration

var passTypeIdentifiers: [String]

get · iOS 27.0+

region

TypeScript

get region(): _Foundation_Locale_Region

Swift declaration

var region: Locale.Region

The region to localize the amounts in the shopping cart.

set · iOS 27.0+

region

TypeScript

set region(value: _Foundation_Locale_Region)

Swift declaration

var region: Locale.Region

The region to localize the amounts in the shopping cart.

get · iOS 27.0+

currency

TypeScript

get currency(): _Foundation_Locale_Currency

Swift declaration

var currency: Locale.Currency

The currency to localize the amounts in the shopping cart.

set · iOS 27.0+

currency

TypeScript

set currency(value: _Foundation_Locale_Currency)

Swift declaration

var currency: Locale.Currency

The currency to localize the amounts in the shopping cart.

init · iOS 27.0+

init

TypeScript

static init(currency: _Foundation_Locale_Currency, region: _Foundation_Locale_Region, privacyPolicyURL: string, websiteURL?: (string) | null, storeName?: (string) | null, deviceName?: (string) | null, passTypeIdentifiers?: Array<string>): CustomerEngagementSession_Configuration

Swift declaration

init(currency: Locale.Currency, region: Locale.Region, privacyPolicyURL: URL, websiteURL: URL? = nil, storeName: String? = nil, deviceName: String? = nil, passTypeIdentifiers: [String] = [])

get · iOS 27.0+

storeName

TypeScript

get storeName(): (string) | null

Swift declaration

var storeName: String?

The store name or location to identify the specific store.

set · iOS 27.0+

storeName

TypeScript

set storeName(value: (string) | null)

Swift declaration

var storeName: String?

The store name or location to identify the specific store.

Skipped declarations

No declarations were skipped in this snapshot.

All ProximityReader types →