GuidesAPI ReferenceRelease Notes
HomeLog InHome
Guides

BlazeRestrictedContentParams

BlazeRestrictedContentParams

BlazeRestrictedContentParams describes the item a viewer was refused. It is passed to onContentRestricted. It deliberately uses the same vocabulary as a widget tap (BlazeWidgetItemClickParams), so a host handling a refusal and a host handling a tap read the same field names and get the same values for the same item.

PropertyTypeDescription
contentIndexIntThe zero-based index of the item in the list the viewer is looking at, ads excluded. Same index a widget tap reports for the item. In a Stories player it counts Stories, not pages.
contentIdStringThe unique content ID of the refused item. For a Story this is the Story, not the page, since entitlement is decided per Story.
extraInfo[String: String]Content-level metadata for the item. For a Story this is the Story's extra info; for a Moment or a Video, the item's own. Empty when there is none.
contentThumbnailUrlString?The URL of the item's main thumbnail, nil when the item has none. Useful for presenting the refused item while offering a way forward.
public struct BlazeRestrictedContentParams {
    public let contentIndex: Int
    public let contentId: String
    public let extraInfo: [String: String]
    public let contentThumbnailUrl: String?

    public init(contentIndex: Int,
                contentId: String,
                extraInfo: [String: String],
                contentThumbnailUrl: String?)
}

Did this page help you?