chromium/ios/chrome/browser/ui/promos_manager/promo_protocol.h

// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef IOS_CHROME_BROWSER_UI_PROMOS_MANAGER_PROMO_PROTOCOL_H_
#define IOS_CHROME_BROWSER_UI_PROMOS_MANAGER_PROMO_PROTOCOL_H_

#import <Foundation/Foundation.h>

#import "ios/chrome/browser/promos_manager/model/constants.h"
#import "ios/chrome/browser/promos_manager/model/impression_limit.h"
#import "ios/chrome/browser/shared/public/commands/promos_manager_commands.h"

struct PromoConfig;

// PromoProtocol defines the minimum set of data required to create a
// Promo maintained by the PromosManager. A promo object must have a
// unique mapping to a promo enum (promos_manager::Promo), and
// (optionally) can define promo-specific impression limits to control
// its display behavior.
@protocol PromoProtocol <NSObject>

@required

// Which promos_manager::Promo the object is uniquely associated with.
- (PromoConfig)config;

@optional

// If implemented, a PromosManagerCommands handler will be provided to the
// class.
@property(nonatomic, weak) id<PromosManagerCommands> handler;

// A generic callback that's invoked immediately after the promo, `identifier`,
// is displayed.
- (void)promoWasDisplayed;

@end

#endif  // IOS_CHROME_BROWSER_UI_PROMOS_MANAGER_PROMO_PROTOCOL_H_