TGFFido2OperationInfo

Objective-C


@interface TGFFido2OperationInfo : NSObject

Swift

class TGFFido2OperationInfo : NSObject

A class that holds common information for an ongoing operation started from TGFClient that the UI needs to display to the user.

@since 1.0.0

  • Initializes an TGFFido2OperationInfo object with details about the ongoing operation.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRpId:(NSString *_Nonnull)rpId
                              rpName:(NSString *_Nullable)rpName
                            userName:(NSString *_Nullable)userName
                     userDisplayName:(NSString *_Nullable)userDisplayName
                       operationType:(TGFFido2OperationType)operationType;

    Swift

    init(rpId: String, rpName: String?, userName: String?, userDisplayName: String?, operationType: TGFFido2OperationType)

    Parameters

    rpId

    The identifier of the Relying Party that initiated the request.
    rpName

    The friendly name of the Relying Party.
    userName

    The username for the account.
    userDisplayName

    The display name for the user account.
    operationType

    The type of FIDO2 operation being performed (e.g., registration or authentication).

    Return Value

    An initialized TGFFido2OperationInfo object.

  • The Relying Party ID from which the request originated from.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nonnull rpId;

    Swift

    var rpId: String { get }

  • The friendly name of the Relying Party.

    Note

    It is empty when operationType = TGFFido2OperationTypeAuthentication

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable rpName;

    Swift

    var rpName: String? { get }

  • The username associated with the operation.

    Note

    It is empty when operationType = TGFFido2OperationTypeAuthentication

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable userName;

    Swift

    var userName: String? { get }

  • The user’s display name.

    Note

    It is empty when operationType = TGFFido2OperationTypeAuthentication

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable userDisplayName;

    Swift

    var userDisplayName: String? { get }

  • The FIDO2 operation type (e.g. registration).

    Declaration

    Objective-C

    @property (readonly) TGFFido2OperationType operationType;

    Swift

    var operationType: TGFFido2OperationType { get }