SearchEngineDefinition

public struct SearchEngineDefinition
extension SearchEngineDefinition: Equatable, Hashable

A definition for an individual search engine to be presented to the user.

  • A list of aliases for this engine.

    Declaration

    Swift

    public var aliases: [String]
  • The character set this engine uses for queries.

    Declaration

    Swift

    public var charset: String
  • The classification of search engine according to the main search types (e.g. general, shopping, travel, dictionary). Currently, only marking as a general search engine is supported. On Android, only general search engines may be selected as “default” search engines.

    Declaration

    Swift

    public var classification: SearchEngineClassification
  • The identifier of the search engine. This is used as an internal identifier, e.g. for saving the user’s settings for the engine. It is also used to form the base telemetry id and may be extended by telemetrySuffix.

    Declaration

    Swift

    public var identifier: String
  • The user visible name of the search engine.

    Declaration

    Swift

    public var name: String
  • This search engine is presented as an option that the user may enable. The application should not include these in the default list of the user’s engines. If not supported, it should filter them out.

    Declaration

    Swift

    public var optional: Bool
  • The partner code for the engine. This will be inserted into parameters which include {partnerCode}. May be the empty string.

    Declaration

    Swift

    public var partnerCode: String
  • Optional suffix that is appended to the search engine identifier following a dash, i.e. <identifier>-<suffix>. If it is an empty string no dash should be appended.

    Declaration

    Swift

    public var telemetrySuffix: String
  • The URLs associated with the search engine.

    Declaration

    Swift

    public var urls: SearchEngineUrls
  • A hint to the order that this engine should be in the engine list. This is derived from the engineOrders section of the search configuration. The higher the number, the nearer to the front it should be. If the number is not specified, other methods of sorting may be relied upon (e.g. alphabetical).

    Declaration

    Swift

    public var orderHint: UInt32?
  • The url used for reporting clicks.

    Declaration

    Swift

    public var clickUrl: String?
  • Declaration

    Swift

    public init(
        /**
         * A list of aliases for this engine.
         */aliases: [String], 
        /**
         * The character set this engine uses for queries.
         */charset: String, 
        /**
         * The classification of search engine according to the main search types
         * (e.g. general, shopping, travel, dictionary). Currently, only marking as
         * a general search engine is supported.
         * On Android, only general search engines may be selected as "default"
         * search engines.
         */classification: SearchEngineClassification, 
        /**
         * The identifier of the search engine. This is used as an internal
         * identifier, e.g. for saving the user's settings for the engine. It is
         * also used to form the base telemetry id and may be extended by telemetrySuffix.
         */identifier: String, 
        /**
         * The user visible name of the search engine.
         */name: String, 
        /**
         * This search engine is presented as an option that the user may enable.
         * The application should not include these in the default list of the
         * user's engines. If not supported, it should filter them out.
         */optional: Bool, 
        /**
         * The partner code for the engine. This will be inserted into parameters
         * which include `{partnerCode}`. May be the empty string.
         */partnerCode: String, 
        /**
         * Optional suffix that is appended to the search engine identifier
         * following a dash, i.e. `<identifier>-<suffix>`. If it is an empty string
         * no dash should be appended.
         */telemetrySuffix: String, 
        /**
         * The URLs associated with the search engine.
         */urls: SearchEngineUrls, 
        /**
         * A hint to the order that this engine should be in the engine list. This
         * is derived from the `engineOrders` section of the search configuration.
         * The higher the number, the nearer to the front it should be.
         * If the number is not specified, other methods of sorting may be relied
         * upon (e.g. alphabetical).
         */orderHint: UInt32?, 
        /**
         * The url used for reporting clicks.
         */clickUrl: String?)
  • Declaration

    Swift

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

    Swift

    public func hash(into hasher: inout Hasher)