/*
 * Copyright (C) 2017 Twitter, Inc.
 *
 * 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>

/**
 *  Protocol for Scribe event objects. Objects that conform to this protocol should easily serialize
 *  itself into an intermediate dictionary that can be further serialized into scribe event JSON.
 */
@protocol TWTRScribeSerializable <NSObject>

/**
 *  Canonical key used to serialize object to Scribe event JSON.
 */
+ (NSString *)scribeKey;
/**
 *  Dictionary used to serialize object to Scribe event JSON.
 */
- (NSDictionary *)dictionaryRepresentation;

@end