/*
 * Copyright 2019 New Vector Ltd
 *
 * 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 im.vector.matrix.android.api.auth.login

import im.vector.matrix.android.api.MatrixCallback
import im.vector.matrix.android.api.session.Session
import im.vector.matrix.android.api.util.Cancelable

interface LoginWizard {

    /**
     * @param login the login field
     * @param password the password field
     * @param deviceName the initial device name
     * @param callback  the matrix callback on which you'll receive the result of authentication.
     * @return return a [Cancelable]
     */
    fun login(login: String,
              password: String,
              deviceName: String,
              callback: MatrixCallback<Session>): Cancelable

    /**
     * Reset user password
     */
    fun resetPassword(email: String,
                      newPassword: String,
                      callback: MatrixCallback<Unit>): Cancelable

    /**
     * Confirm the new password, once the user has checked his email
     */
    fun resetPasswordMailConfirmed(callback: MatrixCallback<Unit>): Cancelable
}
