/*
 * Copyright (C) 2024 The Android Open Source Project
 *
 * 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 android.security.authenticationpolicy;

import static android.security.Flags.FLAG_SECURE_LOCKDOWN;

import android.annotation.FlaggedApi;
import android.annotation.NonNull;
import android.annotation.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;

import java.util.Objects;

/**
 * Parameters related to a request to disable secure lock on the device.
 *
 * @hide
 */
@SystemApi
@FlaggedApi(FLAG_SECURE_LOCKDOWN)
public final class DisableSecureLockDeviceParams implements Parcelable {

    /**
     * Client message associated with the request to disable secure lock on the device. This message
     * will be shown on the device when secure lock mode is disabled.
     *
     * Since this text is shown in a restricted lockscreen state, typeface properties such as color,
     * font weight, or other formatting may not be honored.
     */
    private final @NonNull CharSequence mMessage;

    /**
     * Creates DisableSecureLockDeviceParams with the given params.
     *
     * @param message Allows clients to pass in a message with information about the request to
     *                disable secure lock on the device. This message will be shown to the user when
     *                secure lock mode is disabled. If an empty CharSequence is provided, it will
     *                default to a system-defined CharSequence (e.g. "Secure lock mode has been
     *                disabled.")
     *
     *                Since this text is shown in a restricted lockscreen state, typeface properties
     *                such as color, font weight, or other formatting may not be honored.
     */
    public DisableSecureLockDeviceParams(@NonNull CharSequence message) {
        mMessage = message;
    }

    private DisableSecureLockDeviceParams(@NonNull Parcel in) {
        mMessage = Objects.requireNonNull(in.readCharSequence());
    }

    @NonNull
    public CharSequence getMessage() {
        return mMessage;
    }

    public static final @NonNull Creator<DisableSecureLockDeviceParams> CREATOR =
            new Creator<DisableSecureLockDeviceParams>() {
                @Override
                public DisableSecureLockDeviceParams createFromParcel(Parcel in) {
                    return new DisableSecureLockDeviceParams(in);
                }

                @Override
                public DisableSecureLockDeviceParams[] newArray(int size) {
                    return new DisableSecureLockDeviceParams[size];
                }
            };

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(@NonNull Parcel dest, int flags) {
        dest.writeCharSequence(mMessage);
    }
}