BaseRequest

Kotlin |Java

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 functions
`String!`	`getContentUrl()` Returns the deep link to the content's screen provided in `setContentUrl()`
`SecureSignals?`	`getSecureSignals()` Returns the Secure Signals with custom data
`Any!`	`getUserRequestContext()` Returns the user-provided object that is associated with the request.
`Unit`	`setContentUrl(url: String!)` Specifies the deep link to the content's screen.
`Unit`	`setSecureSignals(signal: SecureSignals?)` Specifies the Secure Signals with custom data for this request.
`Unit`	`setUserRequestContext(userRequestContext: Any!)` Sets the user-provided object that is associated with the request.

Public functions

getContentUrl

fun getContentUrl(): String!

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

getSecureSignals

fun getSecureSignals(): SecureSignals?

Returns the Secure Signals with custom data

getUserRequestContext

fun getUserRequestContext(): Any!

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

setContentUrl

fun setContentUrl(url: String!): Unit

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

fun setSecureSignals(signal: SecureSignals?): Unit

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

fun setUserRequestContext(userRequestContext: Any!): Unit

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.