FRAIdentity.h revision 2beebed98b4fc7f018fb224a1e4a3ab6103a4c0b
/*
* The contents of this file are subject to the terms of the Common Development and
* Distribution License (the License). You may not use this file except in compliance with the
* License.
*
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
* specific language governing permission and limitations under the License.
*
* When distributing Covered Software, include this CDDL Header Notice in each file and include
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
* Header, with the fields enclosed by brackets [] replaced by your own identifying
* information: "Portions copyright [year] [name of copyright owner]".
*
* Copyright 2016 ForgeRock AS.
*/
#import <Foundation/Foundation.h>
/*!
* Identity is responsible for modelling the information that makes up part of a user's identity in
* the context of logging into that user's account.
*/
@interface FRAIdentity : NSObject
/*!
* The storage ID of this identity.
*/
@property (nonatomic) NSInteger uid;
/*!
* Name of the Identity Provider (IdP) that issued this identity.
*/
@property (copy, nonatomic, readonly) NSString* issuer;
/*!
* Name of this identity.
*/
@property (copy, nonatomic, readonly) NSString* accountName;
/*!
* URL pointing to an image (such as a logo) that represents the issuer of this identity.
*/
@property (copy, nonatomic, readonly) NSURL* image;
/*!
* Creates a new identity object with the provided property values.
*/
- (FRAIdentity*)initWithAccountName:(NSString*)accountName issuer:(NSString*)issuer image:(NSURL*)image;
/*!
* Creates a new identity object with the provided property values.
*/
+ (FRAIdentity*)identityWithAccountName:(NSString*)accountName issuer:(NSString*)issuer image:(NSURL*)image;
@end