/*
 Copyright 2009-2016 Urban Airship Inc. All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

 1. Redistributions of source code must retain the above copyright notice, this
 list of conditions and the following disclaimer.

 2. Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.

 THIS SOFTWARE IS PROVIDED BY THE URBAN AIRSHIP INC ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 EVENT SHALL URBAN AIRSHIP INC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#import <Foundation/Foundation.h>

@class UAPreferenceDataStore;

NS_ASSUME_NONNULL_BEGIN

/**
 * The named user is an alternate method of identifying the device. Once a named
 * user is associated to the device, it can be used to send push notifications
 * to the device.
 */
@interface UANamedUser : NSObject

/**
 * The named user ID for this device.
 */
@property (nonatomic, copy, nullable) NSString *identifier;

/**
 * Force updating the association or disassociation of the current named user ID.
 */
- (void)forceUpdate;

/**
 * Add tags to named user tags. To update the server,
 * make all of your changes, then call `updateTags`.
 *
 * @param tags Array of tags to add.
 * @param tagGroupID Tag group ID string.
 */
#if __has_feature(objc_generics)
- (void)addTags:(NSArray<NSString *> *)tags group:(NSString *)tagGroupID;
#else
- (void)addTags:(NSArray *)tags group:(NSString *)tagGroupID;
#endif

/**
 * Removes tags from named user tags. To update the server,
 * make all of your changes, then call `updateTags`.
 *
 * @param tags Array of tags to remove.
 * @param tagGroupID Tag group ID string.
 */
#if __has_feature(objc_generics)
- (void)removeTags:(NSArray<NSString *> *)tags group:(NSString *)tagGroupID;
#else
- (void)removeTags:(NSArray *)tags group:(NSString *)tagGroupID;
#endif

/**
 * Update named user tags.
 */
- (void)updateTags;

@end

NS_ASSUME_NONNULL_END