CBLSessionAuthenticator

@interface CBLSessionAuthenticator : CBLAuthenticator

The CBLSessionAuthenticator class is an authenticator that will authenticate by using the session ID of the session created by a Sync Gateway.

  • Session ID of the session created by a Sync Gateway.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic) NSString *_Nonnull sessionID;

    Swift

    var sessionID: String { get }

  • Session cookie name that the session ID value will be set to when communicating the Sync Gateaway.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic) NSString *_Nonnull cookieName;

    Swift

    var cookieName: String { get }

  • Initializes with the Sync Gateway session ID and uses the default cookie name.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSessionID:(nonnull NSString *)sessionID;

    Swift

    init(sessionID: String)

    Parameters

    sessionID

    Sync Gateway session ID

    Return Value

    The CBLSessionAuthenticator object.

  • Initializes with the session ID and the cookie name. If the given cookieName is nil, the default cookie name will be used.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSessionID:(nonnull NSString *)sessionID
                               cookieName:(nullable NSString *)cookieName;

    Swift

    init(sessionID: String, cookieName: String?)

    Parameters

    sessionID

    Sync Gateway session ID
    cookieName

    The cookie name

    Return Value

    The CBLSessionAuthenticator object.

  • Not available

    Declaration

    Objective-C

    - (nonnull instancetype)init;