FRAMechanism.h revision 91f0e3cb60de3eba8cbb70c7e36cc0df22d71f5b
/*
* 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>
@class FRAIdentity;
@class FRANotification;
/*!
* A mechanism used for authentication within the Authenticator Application.
*
* Encapsulates the related settings, as well as an owning Identity.
*/
@interface FRAMechanism : NSObject
/*!
* The storage ID of this mechanism.
*/
@property (nonatomic) NSInteger uid;
/*!
* The parent Identity object which this mechanism belongs to.
*/
@property (nonatomic) FRAIdentity* parent;
/*!
* A list of the current Notficiations that are assigned to this Mechanism.
*/
@property (getter=notifications, nonatomic, readonly) NSArray<FRANotification*>* notifications;
/*!
* When a new notification is received by the App, it will be appended to
* the owning Mechanism using this method.
*
* @param A notification to add to this Mechanism.
*/
- (void) addNotification:(FRANotification*) notification;
/*!
* Once a Notficiation has been marked as deleted, it will be removed from
* the Mechanism by this method.
*
* @param The noficiation to remove from the Mechanism.
*/
- (void) removeNotification:(FRANotification*) notification;
@end