commonMain.kotbase.SessionAuthenticator.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of couchbase-lite Show documentation

Couchbase Lite Community Edition for Kotlin Multiplatform

There is a newer version: 3.1.3-1.1.0

/*
 * Copyright 2022-2023 Jeff Lockhart
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package kotbase

/**
 * SessionAuthenticator class is an authenticator that will authenticate by using the session ID of
 * the session created by a Sync Gateway
 */
public expect class SessionAuthenticator

/**
 * Initializes with the session ID and the cookie name. If the given cookieName
 * is null, the default cookie name will be used.
 *
 * @param sessionID  Sync Gateway session ID
 * @param cookieName The cookie name
 */
constructor(sessionID: String, cookieName: String? = null) : Authenticator {

    /**
     * Return session ID of the session created by a Sync Gateway.
     */
    public val sessionID: String

    /**
     * Return session cookie name that the session ID value will be set to when communicating
     * the Sync Gateway.
     */
    public val cookieName: String
}