android.bluetooth.BluetoothHeadsetClientCall Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of android-all Show documentation
Show all versions of android-all Show documentation
A library jar that provides APIs for Applications written for the Google Android Platform.
/*
* Copyright (C) 2014 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.bluetooth;
import android.os.Parcel;
import android.os.Parcelable;
/**
* This class represents a single call, its state and properties.
* It implements {@link Parcelable} for inter-process message passing.
* @hide
*/
public final class BluetoothHeadsetClientCall implements Parcelable {
/* Call state */
/**
* Call is active.
*/
public static final int CALL_STATE_ACTIVE = 0;
/**
* Call is in held state.
*/
public static final int CALL_STATE_HELD = 1;
/**
* Outgoing call that is being dialed right now.
*/
public static final int CALL_STATE_DIALING = 2;
/**
* Outgoing call that remote party has already been alerted about.
*/
public static final int CALL_STATE_ALERTING = 3;
/**
* Incoming call that can be accepted or rejected.
*/
public static final int CALL_STATE_INCOMING = 4;
/**
* Waiting call state when there is already an active call.
*/
public static final int CALL_STATE_WAITING = 5;
/**
* Call that has been held by response and hold
* (see Bluetooth specification for further references).
*/
public static final int CALL_STATE_HELD_BY_RESPONSE_AND_HOLD = 6;
/**
* Call that has been already terminated and should not be referenced as a valid call.
*/
public static final int CALL_STATE_TERMINATED = 7;
private final int mId;
private int mState;
private String mNumber;
private boolean mMultiParty;
private final boolean mOutgoing;
/**
* Creates BluetoothHeadsetClientCall instance.
*/
public BluetoothHeadsetClientCall(int id, int state, String number, boolean multiParty,
boolean outgoing) {
mId = id;
mState = state;
mNumber = number != null ? number : "";
mMultiParty = multiParty;
mOutgoing = outgoing;
}
/**
* Sets call's state.
*
* Note: This is an internal function and shouldn't be exposed
*
* @param state new call state.
*/
public void setState(int state) {
mState = state;
}
/**
* Sets call's number.
*
* Note: This is an internal function and shouldn't be exposed
*
* @param number String representing phone number.
*/
public void setNumber(String number) {
mNumber = number;
}
/**
* Sets this call as multi party call.
*
* Note: This is an internal function and shouldn't be exposed
*
* @param multiParty if true sets this call as a part
* of multi party conference.
*/
public void setMultiParty(boolean multiParty) {
mMultiParty = multiParty;
}
/**
* Gets call's Id.
*
* @return call id.
*/
public int getId() {
return mId;
}
/**
* Gets call's current state.
*
* @return state of this particular phone call.
*/
public int getState() {
return mState;
}
/**
* Gets call's number.
*
* @return string representing phone number.
*/
public String getNumber() {
return mNumber;
}
/**
* Checks if call is an active call in a conference mode (aka multi party).
*
* @return true if call is a multi party call,
* false otherwise.
*/
public boolean isMultiParty() {
return mMultiParty;
}
/**
* Checks if this call is an outgoing call.
*
* @return true if its outgoing call,
* false otherwise.
*/
public boolean isOutgoing() {
return mOutgoing;
}
public String toString() {
StringBuilder builder = new StringBuilder("BluetoothHeadsetClientCall{mId: ");
builder.append(mId);
builder.append(", mState: ");
switch (mState) {
case CALL_STATE_ACTIVE: builder.append("ACTIVE"); break;
case CALL_STATE_HELD: builder.append("HELD"); break;
case CALL_STATE_DIALING: builder.append("DIALING"); break;
case CALL_STATE_ALERTING: builder.append("ALERTING"); break;
case CALL_STATE_INCOMING: builder.append("INCOMING"); break;
case CALL_STATE_WAITING: builder.append("WAITING"); break;
case CALL_STATE_HELD_BY_RESPONSE_AND_HOLD: builder.append("HELD_BY_RESPONSE_AND_HOLD"); break;
case CALL_STATE_TERMINATED: builder.append("TERMINATED"); break;
default: builder.append(mState); break;
}
builder.append(", mNumber: ");
builder.append(mNumber);
builder.append(", mMultiParty: ");
builder.append(mMultiParty);
builder.append(", mOutgoing: ");
builder.append(mOutgoing);
builder.append("}");
return builder.toString();
}
/**
* {@link Parcelable.Creator} interface implementation.
*/
public static final Parcelable.Creator CREATOR =
new Parcelable.Creator() {
@Override
public BluetoothHeadsetClientCall createFromParcel(Parcel in) {
return new BluetoothHeadsetClientCall(in.readInt(), in.readInt(),
in.readString(), in.readInt() == 1, in.readInt() == 1);
}
@Override
public BluetoothHeadsetClientCall[] newArray(int size) {
return new BluetoothHeadsetClientCall[size];
}
};
@Override
public void writeToParcel(Parcel out, int flags) {
out.writeInt(mId);
out.writeInt(mState);
out.writeString(mNumber);
out.writeInt(mMultiParty ? 1 : 0);
out.writeInt(mOutgoing ? 1 : 0);
}
@Override
public int describeContents() {
return 0;
}
}