116 lines
3.9 KiB
Java
116 lines
3.9 KiB
Java
![]() |
/*
|
||
|
* Copyright (C) 2017 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.service.autofill;
|
||
|
|
||
|
import android.annotation.NonNull;
|
||
|
import android.annotation.Nullable;
|
||
|
import android.os.Bundle;
|
||
|
import android.os.Parcel;
|
||
|
import android.os.Parcelable;
|
||
|
|
||
|
import java.util.ArrayList;
|
||
|
import java.util.List;
|
||
|
import java.util.Objects;
|
||
|
|
||
|
/**
|
||
|
* This class represents a request to an {@link AutofillService
|
||
|
* autofill provider} to save applicable data entered by the user.
|
||
|
*
|
||
|
* @see AutofillService#onSaveRequest(SaveRequest, SaveCallback)
|
||
|
*/
|
||
|
public final class SaveRequest implements Parcelable {
|
||
|
private final @NonNull ArrayList<FillContext> mFillContexts;
|
||
|
private final @Nullable Bundle mClientState;
|
||
|
private final @Nullable ArrayList<String> mDatasetIds;
|
||
|
|
||
|
/** @hide */
|
||
|
public SaveRequest(@NonNull ArrayList<FillContext> fillContexts,
|
||
|
@Nullable Bundle clientState, @Nullable ArrayList<String> datasetIds) {
|
||
|
mFillContexts = Objects.requireNonNull(fillContexts, "fillContexts");
|
||
|
mClientState = clientState;
|
||
|
mDatasetIds = datasetIds;
|
||
|
}
|
||
|
|
||
|
private SaveRequest(@NonNull Parcel parcel) {
|
||
|
this(parcel.createTypedArrayList(FillContext.CREATOR),
|
||
|
parcel.readBundle(), parcel.createStringArrayList());
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Gets the contexts associated with each previous fill request.
|
||
|
*
|
||
|
* <p><b>Note:</b> Starting on Android {@link android.os.Build.VERSION_CODES#Q}, it could also
|
||
|
* include contexts from requests whose {@link SaveInfo} had the
|
||
|
* {@link SaveInfo#FLAG_DELAY_SAVE} flag.
|
||
|
*
|
||
|
* @return The contexts associated with each previous fill request.
|
||
|
*/
|
||
|
public @NonNull List<FillContext> getFillContexts() {
|
||
|
return mFillContexts;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Gets the latest client state bundle set by the service in a
|
||
|
* {@link FillResponse.Builder#setClientState(Bundle) fill response}.
|
||
|
*
|
||
|
* <p><b>Note:</b> Prior to Android {@link android.os.Build.VERSION_CODES#P}, only client state
|
||
|
* bundles set by {@link FillResponse.Builder#setClientState(Bundle)} were considered. On
|
||
|
* Android {@link android.os.Build.VERSION_CODES#P} and higher, bundles set in the result of
|
||
|
* an authenticated request through the
|
||
|
* {@link android.view.autofill.AutofillManager#EXTRA_CLIENT_STATE} extra are
|
||
|
* also considered (and take precedence when set).
|
||
|
*
|
||
|
* @return The client state.
|
||
|
*/
|
||
|
public @Nullable Bundle getClientState() {
|
||
|
return mClientState;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Gets the ids of the datasets selected by the user, in the order in which they were selected.
|
||
|
*/
|
||
|
@Nullable
|
||
|
public List<String> getDatasetIds() {
|
||
|
return mDatasetIds;
|
||
|
}
|
||
|
|
||
|
@Override
|
||
|
public int describeContents() {
|
||
|
return 0;
|
||
|
}
|
||
|
|
||
|
@Override
|
||
|
public void writeToParcel(Parcel parcel, int flags) {
|
||
|
parcel.writeTypedList(mFillContexts, flags);
|
||
|
parcel.writeBundle(mClientState);
|
||
|
parcel.writeStringList(mDatasetIds);
|
||
|
}
|
||
|
|
||
|
public static final @android.annotation.NonNull Creator<SaveRequest> CREATOR =
|
||
|
new Creator<SaveRequest>() {
|
||
|
@Override
|
||
|
public SaveRequest createFromParcel(Parcel parcel) {
|
||
|
return new SaveRequest(parcel);
|
||
|
}
|
||
|
|
||
|
@Override
|
||
|
public SaveRequest[] newArray(int size) {
|
||
|
return new SaveRequest[size];
|
||
|
}
|
||
|
};
|
||
|
}
|