SearchUserEnvironment

public struct SearchUserEnvironment
extension SearchUserEnvironment: Equatable, Hashable

The user’s environment that is used for filtering the search configuration.

  • The current locale of the application that the user is using.

    Declaration

    Swift

    public var locale: String
  • The home region that the user is currently identified as being within. On desktop & android there is a 14 day lag after detecting a region change before the home region changes. TBD: iOS?

    Declaration

    Swift

    public var region: String
  • The update channel of the user’s build.

    Declaration

    Swift

    public var updateChannel: SearchUpdateChannel
  • The distribution id for the user’s build.

    Declaration

    Swift

    public var distributionId: String
  • The search related experiment id that the user is included within. On desktop this is the searchConfiguration.experiment variable.

    Declaration

    Swift

    public var experiment: String
  • The application name that the user is using.

    Declaration

    Swift

    public var appName: SearchApplicationName
  • The application version that the user is using.

    Declaration

    Swift

    public var version: String
  • The device type that the user is using.

    Declaration

    Swift

    public var deviceType: SearchDeviceType
  • Declaration

    Swift

    public init(
        /**
         * The current locale of the application that the user is using.
         */locale: String, 
        /**
         * The home region that the user is currently identified as being within.
         * On desktop & android there is a 14 day lag after detecting a region
         * change before the home region changes. TBD: iOS?
         */region: String, 
        /**
         * The update channel of the user's build.
         */updateChannel: SearchUpdateChannel, 
        /**
         * The distribution id for the user's build.
         */distributionId: String, 
        /**
         * The search related experiment id that the user is included within. On
         * desktop this is the `searchConfiguration.experiment` variable.
         */experiment: String, 
        /**
         * The application name that the user is using.
         */appName: SearchApplicationName, 
        /**
         * The application version that the user is using.
         */version: String, 
        /**
         * The device type that the user is using.
         */deviceType: SearchDeviceType)
  • Declaration

    Swift

    public static func == (lhs: SearchUserEnvironment, rhs: SearchUserEnvironment) -> Bool
  • Declaration

    Swift

    public func hash(into hasher: inout Hasher)