BaseRequest

Kotlin |Java

public interface BaseRequest

Known direct subclasses

AdsRequest, StreamRequest

`AdsRequest`	An object containing the data used to request ads from the server.
`StreamRequest`	An object containing the data used to request a stream with server-side ad insertion.

Base interface for requesting ads. Subclassed by AdsRequest for directly requested ads and StreamRequest for dynamic ad insertion streams.

Summary

Public methods
`abstract String`	`getContentUrl()` Returns the deep link to the content's screen provided in `setContentUrl()`
`abstract @Nullable SecureSignals`	`getSecureSignals()` Returns the Secure Signals with custom data
`abstract Object`	`getUserRequestContext()` Returns the user-provided object that is associated with the request.
`abstract void`	`setContentUrl(String url)` Specifies the deep link to the content's screen.
`abstract void`	`setSecureSignals(@Nullable SecureSignals signal)` Specifies the Secure Signals with custom data for this request.
`abstract void`	`setUserRequestContext(Object userRequestContext)` Sets the user-provided object that is associated with the request.

Public methods

getContentUrl

abstract String getContentUrl()

Returns the deep link to the content's screen provided in setContentUrl()

getSecureSignals

abstract @Nullable SecureSignals getSecureSignals()

Returns the Secure Signals with custom data

getUserRequestContext

abstract Object getUserRequestContext()

Returns the user-provided object that is associated with the request.

setContentUrl

abstract void setContentUrl(String url)

Specifies the deep link to the content's screen. If provided, this parameter is passed to the OM SDK. See Android documentation for more information.

setSecureSignals

abstract void setSecureSignals(@Nullable SecureSignals signal)

Specifies the Secure Signals with custom data for this request. Secure Signals with custom data is an encrypted blob containing signals collected by the publisher and previously agreed upon by the publisher and bidder. The Secure Signals with custom data can be cleared out by passing null to this function.

setUserRequestContext

abstract void setUserRequestContext(Object userRequestContext)

Sets the user-provided object that is associated with the request. If supplied here, it will be available once the ad load is complete or fails. This object can be used to identify the request that caused an error or which request loaded a particular ads manager.