UserInfo

@objc(FRUserInfo)
public class UserInfo : NSObject, NSSecureCoding

UserInfo class is a representation of a user’s UserInfo data according to OAuth2 and OIDC spec. UserInfo is retrieved using /userinfo endpoint.

Property

  • Name

    Declaration

    Swift

    @objc
public var name: String?

  • Family name

    Declaration

    Swift

    @objc
public var familyName: String?

  • Given name

    Declaration

    Swift

    @objc
public var givenName: String?

  • Middle name

    Declaration

    Swift

    @objc
public var middleName: String?

  • Nickname

    Declaration

    Swift

    @objc
public var nickName: String?

  • Preferred Username

    Declaration

    Swift

    @objc
public var preferredUsername: String?

  • Profile URL

    Declaration

    Swift

    @objc
public var profile: URL?

  • Picture URL

    Declaration

    Swift

    @objc
public var picture: URL?

  • Website URL

    Declaration

    Swift

    @objc
public var website: URL?

  • Gender

    Declaration

    Swift

    @objc
public var gender: String?

  • BirthDate in Date

    Declaration

    Swift

    @objc
public var birthDate: Date?

  • Zone information

    Declaration

    Swift

    @objc
public var zoneInfo: String?

  • Locale

    Declaration

    Swift

    @objc
public var locale: String?
  • sub

    Subject

    Declaration

    Swift

    @objc
public var sub: String?

  • Email address

    Declaration

    Swift

    @objc
public var email: String?

  • Boolean indicator whether user’s email address is verified

    Declaration

    Swift

    @objc
public var emailVerified: Bool

  • Phone number

    Declaration

    Swift

    @objc
public var phoneNumber: String?

  • Boolean indicator whether user’s phone number is verified

    Declaration

    Swift

    @objc
public var phoneNumberVerified: Bool

  • Address object which contains detailed Address information

    Declaration

    Swift

    @objc
public var address: Address?

  • Raw JSON response of /userinfo endpoint

    Declaration

    Swift

    @objc
public var userInfo: [String : Any]

Debug

  • Prints debug description of UserInfo object

    Declaration

    Swift

    override public var debugDescription: String { get }

NSSecureCoding

  • Boolean value of whether SecureCoding is supported or not

    Declaration

    Swift

    public class var supportsSecureCoding: Bool { get }

  • Initializes UserInfo object with NSCoder

    Declaration

    Swift

    convenience required public init?(coder aDecoder: NSCoder)

    Parameters

    aDecoder

    NSCoder

  • Encodes UserInfo object with NSCoder

    Declaration

    Swift

    public func encode(with aCoder: NSCoder)

    Parameters

    aCoder

    NSCoder