Surface

The Surface class represents an entity for user or system interaction. It is identified by a self-describing URI which is used to fetch the decision propositions from the AJO campaigns. For example, all mobile application surface URIs start with mobileapp://, followed by app bundle identifier and an optional path.

iOS Interface - Surface

Surface class is used to create surface instances for requesting propositions in personalization query requests.

Public variables

uri

Unique surface URI string.

public let uri: String
Copied to your clipboard
public let uri: String

Public functions

init

Creates a new surface by appending the given surface path to the mobile app surface prefix.

iOS

Swift

Syntax

public init(path: String)
Copied to your clipboard
public init(path: String)

path is a string representation for the surface path.

Example

// Creates a surface instance representing a banner within homeView view in my mobile application.
let surface = Surface(path: "homeView#banner")
Copied to your clipboard
// Creates a surface instance representing a banner within homeView view in my mobile application.
let surface = Surface(path: "homeView#banner")

Swift

Syntax

public init(path: String)
Copied to your clipboard
public init(path: String)

path is a string representation for the surface path.

Example

// Creates a surface instance representing a banner within homeView view in my mobile application.
let surface = Surface(path: "homeView#banner")
Copied to your clipboard
// Creates a surface instance representing a banner within homeView view in my mobile application.
let surface = Surface(path: "homeView#banner")

Android Interface - Surface

Surface class is used to create surface objects for requesting propositions in personalization query requests.

Public functions

Parameterized Constructor

Creates a new surface by appending the given surface path to the mobile app surface prefix.

Android

Java

Syntax

public Surface(final String path)
Copied to your clipboard
public Surface(final String path)

path is a string containing the surface path.

Example

// Creates a surface instance representing a banner view within homeActivity in my mobile application.
final Surface surface = new Surface("homeActivity#banner")
Copied to your clipboard
// Creates a surface instance representing a banner view within homeActivity in my mobile application.
final Surface surface = new Surface("homeActivity#banner")

Java

Syntax

public Surface(final String path)
Copied to your clipboard
public Surface(final String path)

path is a string containing the surface path.

Example

// Creates a surface instance representing a banner view within homeActivity in my mobile application.
final Surface surface = new Surface("homeActivity#banner")
Copied to your clipboard
// Creates a surface instance representing a banner view within homeActivity in my mobile application.
final Surface surface = new Surface("homeActivity#banner")

Default Constructor

Creates a new base surface by appending application package name to the mobile app surface prefix mobileapp://.

Android

Java

Syntax

public Surface()
Copied to your clipboard
public Surface()

Example

// Creates a new base surface by appending application package name to the mobile app surface prefix mobileapp://
final Surface surface = new Surface()
Copied to your clipboard
// Creates a new base surface by appending application package name to the mobile app surface prefix mobileapp://
final Surface surface = new Surface()

Java

Syntax

public Surface()
Copied to your clipboard
public Surface()

Example

// Creates a new base surface by appending application package name to the mobile app surface prefix mobileapp://
final Surface surface = new Surface()
Copied to your clipboard
// Creates a new base surface by appending application package name to the mobile app surface prefix mobileapp://
final Surface surface = new Surface()

getUri

Returns this surface's URI as a string.

Android

Java

Syntax

public String getUri()
Copied to your clipboard
public String getUri()

Example

final Surface surface = new Surface("homeActivity#banner")
final String uri = surface.getUri()
Copied to your clipboard
final Surface surface = new Surface("homeActivity#banner")
final String uri = surface.getUri()

Java

Syntax

public String getUri()
Copied to your clipboard
public String getUri()

Example

final Surface surface = new Surface("homeActivity#banner")
final String uri = surface.getUri()
Copied to your clipboard
final Surface surface = new Surface("homeActivity#banner")
final String uri = surface.getUri()