firebase-ios-sdk/FirebaseInAppMessaging/Sources/Private/Data/FIRIAMFetchResponseParser.h

/*
 * Copyright 2017 Google
 *
 * 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>

@class FIRIAMMessageDefinition;
@protocol FIRIAMTimeFetcher;

NS_ASSUME_NONNULL_BEGIN

// Class responsible for parsing the json response data from the restful API endpoint
// for serving eligible messages for the current SDK clients.
@interface FIRIAMFetchResponseParser : NSObject

// Turn the API response into a number of FIRIAMMessageDefinition objects. If any of them is invalid
// it would be ignored and not represented in the response array.
// @param discardCount if not nil, it would contain, on return, the number of invalid messages
// detected uring parsing.
// @param fetchWaitTime would be non nil if fetch wait time data is found in the api response.
- (NSArray<FIRIAMMessageDefinition *> *)parseAPIResponseDictionary:(NSDictionary *)responseDict
                                                 discardedMsgCount:(NSInteger *)discardCount
                                            fetchWaitTimeInSeconds:
                                                (NSNumber *_Nullable *_Nonnull)fetchWaitTime;

- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithTimeFetcher:(id<FIRIAMTimeFetcher>)timeFetcher;
@end
NS_ASSUME_NONNULL_END