ARTAuthInternal
Objective-C
@interface ARTAuthInternal : NSObject
@property (nullable, readonly) NSString *clientId;
@property (nullable, nonatomic, readonly) ARTTokenDetails *tokenDetails;
- (void)requestToken:(nullable ARTTokenParams *)tokenParams
withOptions:(nullable ARTAuthOptions *)authOptions
callback:(ARTTokenDetailsCallback)callback;
- (void)requestToken:(ARTTokenDetailsCallback)callback;
- (void)authorize:(nullable ARTTokenParams *)tokenParams
options:(nullable ARTAuthOptions *)authOptions
callback:(ARTTokenDetailsCallback)callback;
- (void)authorize:(ARTTokenDetailsCallback)callback;
- (void)createTokenRequest:(nullable ARTTokenParams *)tokenParams
options:(nullable ARTAuthOptions *)options
callback:(void (^)(ARTTokenRequest *_Nullable tokenRequest, NSError *_Nullable error))callback;
- (void)createTokenRequest:(void (^)(ARTTokenRequest *_Nullable tokenRequest, NSError *_Nullable error))callback;
@end
Swift
class ARTAuthInternal : NSObject
Undocumented
-
Undocumented
Declaration
Objective-C
@property (nullable, readonly) NSString *clientId
Swift
var clientId: String? { get }
-
Undocumented
Declaration
Objective-C
@property (nullable, nonatomic, readonly) ARTTokenDetails *tokenDetails
Swift
var tokenDetails: ARTTokenDetails? { get }
-
Undocumented
Declaration
Objective-C
- (void)requestToken:(nullable ARTTokenParams *)tokenParams withOptions:(nullable ARTAuthOptions *)authOptions callback:(ARTTokenDetailsCallback)callback;
Swift
func requestToken(_ tokenParams: ARTTokenParams?, with authOptions: ARTAuthOptions?, callback: @escaping ARTTokenDetailsCallback)
-
Undocumented
Declaration
Objective-C
- (void)requestToken:(ARTTokenDetailsCallback)callback;
Swift
func requestToken(_ callback: @escaping ARTTokenDetailsCallback)
-
Undocumented
Declaration
Objective-C
- (void)authorize:(nullable ARTTokenParams *)tokenParams options:(nullable ARTAuthOptions *)authOptions callback:(ARTTokenDetailsCallback)callback;
Swift
func authorize(_ tokenParams: ARTTokenParams?, options authOptions: ARTAuthOptions?, callback: @escaping ARTTokenDetailsCallback)
-
Undocumented
Declaration
Objective-C
- (void)authorize:(ARTTokenDetailsCallback)callback;
Swift
func authorize(_ callback: @escaping ARTTokenDetailsCallback)
-
Undocumented
Declaration
Objective-C
- (void)createTokenRequest:(nullable ARTTokenParams *)tokenParams options:(nullable ARTAuthOptions *)options callback:(void (^)(ARTTokenRequest *_Nullable tokenRequest, NSError *_Nullable error))callback;
Swift
func createTokenRequest(_ tokenParams: ARTTokenParams?, options: ARTAuthOptions?, callback: @escaping (ARTTokenRequest?, (any Error)?) -> Void)
-
Undocumented
Declaration
Objective-C
- (void)createTokenRequest:(void (^)(ARTTokenRequest *_Nullable tokenRequest, NSError *_Nullable error))callback;
Swift
func createTokenRequest(_ callback: @escaping (ARTTokenRequest?, (any Error)?) -> Void)
-
Undocumented
Declaration
Objective-C
@property (readonly, nonatomic) dispatch_queue_t queue
Swift
var queue: dispatch_queue_t { get }
-
Undocumented
Declaration
Objective-C
- (NSString *)clientId_nosync;
Swift
func clientId_nosync() -> String
-
Undocumented
Declaration
Objective-C
@property (nonatomic, readonly) ARTClientOptions *options
Swift
var options: ARTClientOptions { get }
-
Undocumented
Declaration
Objective-C
@property (nonatomic, readonly) ARTAuthMethod method
Swift
var method: ARTAuthMethod { get }
-
Undocumented
Declaration
Objective-C
@property (readonly) BOOL isTokenAuth
Swift
var isTokenAuth: Bool { get }
-
Undocumented
Declaration
Objective-C
@property (nullable, nonatomic, readonly) NSNumber *timeOffset
Swift
var timeOffset: NSNumber? { get }
-
Undocumented
Declaration
Objective-C
@property (nullable, weak) id<ARTAuthDelegate> delegate
Swift
weak var delegate: (any ARTAuthDelegate)? { get set }
-
Undocumented
Declaration
Objective-C
@property (readonly) BOOL authorizing
Swift
var authorizing: Bool { get }
-
Undocumented
Declaration
Objective-C
@property (readonly) BOOL authorizing_nosync
Swift
var authorizing_nosync: Bool { get }
-
Undocumented
Declaration
Objective-C
- (nullable NSObject<ARTCancellable> *)_authorize:(nullable ARTTokenParams *)tokenParams options:(nullable ARTAuthOptions *)authOptions callback:(ARTTokenDetailsCallback)callback;
Swift
func _authorize(_ tokenParams: ARTTokenParams?, options authOptions: ARTAuthOptions?, callback: @escaping ARTTokenDetailsCallback) -> (any ARTCancellable & NSObjectProtocol)?
-
Undocumented
Declaration
Objective-C
- (void)cancelAuthorization:(nullable ARTErrorInfo *)error;
Swift
func cancelAuthorization(_ error: ARTErrorInfo?)
-
Undocumented
Declaration
Objective-C
- (nullable NSObject<ARTCancellable> *)_requestToken:(ARTTokenParams *_Nullable)tokenParams withOptions:(ARTAuthOptions *_Nullable)authOptions callback:(ARTTokenDetailsCallback)callback;
Swift
func _requestToken(_ tokenParams: ARTTokenParams?, with authOptions: ARTAuthOptions?, callback: @escaping ARTTokenDetailsCallback) -> (any ARTCancellable & NSObjectProtocol)?
-
Undocumented
Declaration
Objective-C
- (instancetype)init:(ARTRestInternal *)rest withOptions:(ARTClientOptions *)options logger:(ARTInternalLog *)logger;
Swift
init(_ rest: ARTRestInternal, with options: ARTClientOptions, logger: InternalLog)
-
Undocumented
Declaration
Objective-C
- (ARTAuthOptions *)mergeOptions:(ARTAuthOptions *)customOptions;
Swift
func mergeOptions(_ customOptions: ARTAuthOptions) -> ARTAuthOptions
-
Undocumented
Declaration
Objective-C
- (ARTTokenParams *)mergeParams:(ARTTokenParams *)customParams;
Swift
func merge(_ customParams: ARTTokenParams) -> ARTTokenParams
-
Undocumented
Declaration
Objective-C
- (NSURL *)buildURL:(ARTAuthOptions *)options withParams:(ARTTokenParams *)params;
Swift
func buildURL(_ options: ARTAuthOptions, with params: ARTTokenParams) -> URL
-
Undocumented
Declaration
Objective-C
- (NSMutableURLRequest *)buildRequest:(nullable ARTAuthOptions *)options withParams:(nullable ARTTokenParams *)params;
Swift
func buildRequest(_ options: ARTAuthOptions?, with params: ARTTokenParams?) -> NSMutableURLRequest
-
Undocumented
Declaration
Objective-C
- (nullable NSObject<ARTCancellable> *)executeTokenRequest:(ARTTokenRequest *)tokenRequest callback:(void (^)(ARTTokenDetails *_Nullable tokenDetails, NSError *_Nullable error))callback;
Swift
func execute(_ tokenRequest: ARTTokenRequest, callback: @escaping (ARTTokenDetails?, (any Error)?) -> Void) -> (any ARTCancellable & NSObjectProtocol)?
-
Undocumented
Declaration
Objective-C
- (void)setProtocolClientId:(NSString *)clientId;
Swift
func setProtocolClientId(_ clientId: String)
-
Undocumented
Declaration
Objective-C
- (void)discardTimeOffset;
Swift
func discardTimeOffset()
-
Undocumented
Declaration
Objective-C
- (BOOL)canRenewTokenAutomatically:(ARTAuthOptions *)options;
Swift
func canRenewTokenAutomatically(_ options: ARTAuthOptions) -> Bool
-
Does the client have a means to renew the token automatically.
Declaration
Objective-C
- (BOOL)tokenIsRenewable;
Swift
func tokenIsRenewable() -> Bool
-
Does the client have a valid token (i.e. not expired).
Declaration
Objective-C
- (BOOL)tokenRemainsValid;
Swift
func tokenRemainsValid() -> Bool
-
Undocumented
Declaration
Objective-C
- (void)setTokenDetails:(nullable ARTTokenDetails *)tokenDetails;
Swift
func setTokenDetails(_ tokenDetails: ARTTokenDetails?)
-
Undocumented
Declaration
Objective-C
- (void)setTimeOffset:(NSTimeInterval)offset;
Swift
func setTimeOffset(_ offset: TimeInterval)
-
Undocumented
Declaration
Objective-C
- (void)clearTimeOffset;
Swift
func clearTimeOffset()
-
Undocumented
-
Undocumented
Declaration
Objective-C
- (NSString *_Nullable)appId;
Swift
func appId() -> String?