Package com.day.cq.wcm.mobile.api.device

Interface DeviceGroupFilter

public interface DeviceGroupFilter
A DeviceGroupFilter specifies filtering of device groups against a user agent extracted from the request and a set of mobile device capabilities extracted from the WURFL database.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Returns a human-readable description of what this device group filter does.
    String
    getTitle()
    Returns a human-readable title for offering filter choices in the UI.
    boolean
    matches(DeviceGroup group, String userAgent, Map<String,String> capabilities)
    Indicates whether the given device group matches the userAgent and mobile capabilities extracted from the request and the WURFL database.

  • Method Details

    • getDescription

      String getDescription()
      Returns a human-readable description of what this device group filter does.
      Returns:
      The description.

    • getTitle

      String getTitle()
      Returns a human-readable title for offering filter choices in the UI.
      Returns:
      The title.

    • matches

      boolean matches(DeviceGroup group, String userAgent, Map<String,String> capabilities)
      Indicates whether the given device group matches the userAgent and mobile capabilities extracted from the request and the WURFL database.
      Parameters:
      group - The DeviceGroup to be matched against user agent and capabilities.
      userAgent - The user agent string as extracted from the request.
      capabilities - The mobile device capabilities as extracted from the WURFL database.
      Returns:
      true if the device group matches the user agent and capabilities.