DITAuthenticationStatus

@interface DITAuthenticationStatus : NSObject

Provides info about the authentication status.

  • Returns YES if authenticated, otherwise returns NO.

    Declaration

    Objective-C

    @property (nonatomic, readonly, getter=isAuthenticated) BOOL authenticated;

  • If authenticated, returns the user ID if one was provided by the authentication service. Otherwise returns nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *userID;

  • Convenience initializer, same as [... initAuthenticated:NO userID:nil].

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Initializes an authentication status object with the given parameters.

    Declaration

    Objective-C

    - (nonnull instancetype)initAuthenticated:(BOOL)isAuthenticated
                                   userID:(nullable NSString *)userID;

  • Returns YES if passed object is an instance of DITAuthenticationStatus and equal to the receiver. Otherwise returns NO.

    Declaration

    Objective-C

    - (BOOL)isEqual:(nullable id)object;

  • Returns YES if passed authenticationStatus is equal to the receiver. Otherwise returns NO. This is a faster variant of isEqual:, use this if you know for sure authenticationStatus to be a kind of DITAuthenticationStatus.

    Declaration

    Objective-C

    - (BOOL)isEqualToAuthenticationStatus:
    (nonnull DITAuthenticationStatus *)authenticationStatus;

  • Returns the hash for the receiver.

    Declaration

    Objective-C

    - (NSUInteger)hash;

  • Returns a string representation of the receiver.

    Declaration

    Objective-C

    - (nonnull NSString *)description;