SearchEventTemplate

@objc(SearchEventTemplate)
public class SearchEventTemplate : NSObject

A SearchEventTemplate represents a custom search event template for the application.

  • The event’s value. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

    Declaration

    Swift

    @objc
public var eventValue: NSNumber?

  • The event’s type.

    Declaration

    Swift

    @objc
public var type: String?

  • The event’s identifier.

    Declaration

    Swift

    @objc
public var identifier: String?

  • The event’s category.

    Declaration

    Swift

    @objc
public var category: String?

  • The event’s query.

    Declaration

    Swift

    @objc
public var query: String?

  • The event’s total results.

    Declaration

    Swift

    @objc
public var totalResults: Int

  • Default constructor.

    Declaration

    Swift

    public init(value: NSNumber? = nil)

    Parameters

    value

    The value of the event. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

  • Factory method for creating a search event template with a value.

    Declaration

    Swift

    @objc(templateWithValue:)
public class func template(value: NSNumber) -> SearchEventTemplate

    Parameters

    value

    The value of the event. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

    Return Value

    SearchEventTemplate instance.

  • Factory method for creating a search event template.

    Declaration

    Swift

    @objc(template)
public class func template() -> SearchEventTemplate

    Return Value

    SearchEventTemplate instance.

  • Creates the custom search event.

    Declaration

    Swift

    @objc
public func createEvent() -> CustomEvent

    Return Value

    Created UACustomEvent instance.