//
// Copyright (C) 2015 Google, Inc.
//
// SampleAdRequest.h
// Sample Ad Network SDK
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

#import <Foundation/Foundation.h>

/// Sample error codes.
typedef NS_ENUM(NSInteger, SampleErrorCode) {
  SampleErrorCodeBadRequest,    ///< Bad request.
  SampleErrorCodeUnknown,       ///< Unknown error.
  SampleErrorCodeNetworkError,  ///< Network error.
  SampleErrorCodeNoInventory,   ///< No inventory.
};

/// The SampleAdRequest class is used for making an ad request.
@interface SampleAdRequest : NSObject

/// Test ads will be returned if set to YES.
@property(nonatomic, assign) BOOL testMode;

/// Array of keyword strings for describing the current user activity.
@property(nonatomic, copy) NSArray<NSString *> *keywords;

/// A flag that indicates whether ad video audio should be muted.
@property(nonatomic) BOOL mute;

@end
