2018-11-19 12:44:58 +03:00
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
|
|
|
|
@class MSDevice;
|
|
|
|
|
|
|
|
@protocol MSLog <NSObject>
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Log type.
|
|
|
|
*/
|
|
|
|
@property(nonatomic, copy) NSString *type;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Log timestamp.
|
|
|
|
*/
|
|
|
|
@property(nonatomic) NSDate *timestamp;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* A session identifier is used to correlate logs together. A session is an abstract concept in the API and is not necessarily an analytics
|
|
|
|
* session, it can be used to only track crashes.
|
|
|
|
*/
|
|
|
|
@property(nonatomic, copy) NSString *sid;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Optional distribution group ID value.
|
|
|
|
*/
|
|
|
|
@property(nonatomic, copy) NSString *distributionGroupId;
|
|
|
|
|
2019-03-07 17:08:56 +03:00
|
|
|
/**
|
|
|
|
* Optional user identifier.
|
|
|
|
*/
|
|
|
|
@property(nonatomic, copy) NSString *userId;
|
|
|
|
|
2018-11-19 12:44:58 +03:00
|
|
|
/**
|
|
|
|
* Device properties associated to this log.
|
|
|
|
*/
|
|
|
|
@property(nonatomic) MSDevice *device;
|
|
|
|
|
2018-12-02 22:31:00 +03:00
|
|
|
/**
|
|
|
|
* Transient object tag. For example, a log can be tagged with a transmission target. We do this currently to prevent properties being
|
|
|
|
* applied retroactively to previous logs by comparing their tags.
|
|
|
|
*/
|
|
|
|
@property(nonatomic) NSObject *tag;
|
|
|
|
|
2018-11-19 12:44:58 +03:00
|
|
|
/**
|
|
|
|
* Checks if the object's values are valid.
|
|
|
|
*
|
|
|
|
* @return YES, if the object is valid.
|
|
|
|
*/
|
|
|
|
- (BOOL)isValid;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds a transmission target token that this log should be sent to.
|
|
|
|
*
|
|
|
|
* @param token The transmission target token.
|
|
|
|
*/
|
|
|
|
- (void)addTransmissionTargetToken:(NSString *)token;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets all transmission target tokens that this log should be sent to.
|
|
|
|
*
|
|
|
|
* @returns Collection of transmission target tokens that this log should be sent to.
|
|
|
|
*/
|
|
|
|
- (NSSet *)transmissionTargetTokens;
|
|
|
|
|
|
|
|
@end
|