lge.qpair.api.r2.IPeerContext.aidl Maven / Gradle / Ivy
Show all versions of qpair-apis Show documentation
package com.lge.qpair.api.r2;
import com.lge.qpair.api.r2.IPeerIntent;
/**
* The IPeerContext interface implements a context for the peer device.
*/
interface IPeerContext {
/**
* Creates an empty peer intent.
*
* @return a new peer intent.
*/
IPeerIntent newPeerIntent();
/**
* Starts an Activity on the peer device with the given peer intent.
*
* @param intent A peer intent for creating {@link android.content.Intent} which will
* be used for starting an Activity on the peer device.
* @param successIntent An Intent for callback. This intent will be broadcast to the local device if the request succeeds to process. It could be null.
* @param errorIntent An Intent for callback. This intent will be broadcast to the local device if the request fails to process. It could be null.
* errorIntent has an extra field with name {@link com.lge.qpair.api.r2.QPairConstants#EXTRA_CAUSE QPairConstants.EXTRA_CAUSE} and type String.
* Each value in the extra field represents the following meaning.
*
Value
Meaning
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_QPAIR_IS_OFF CAUSE_QPAIR_IS_OFF}
QPair is currently off.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_QPAIR_HAVE_INTERNAL_ERROR CAUSE_QPAIR_HAVE_INTERNAL_ERROR}
QPair got an internal error.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_IS_NOT_AVAILABLE CAUSE_CONNECTION_IS_NOT_AVAILABLE}
Connection to the peer device is not available. The most possible reason is that Bluetooth does not turn on.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_IS_NOT_ESTABLISHED CAUSE_CONNECTION_IS_NOT_ESTABLISHED}
Connection to the peer device is not established. The most possible reason is that the peer device is not close enough to the local device.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_IS_NOT_STABLE CAUSE_CONNECTION_IS_NOT_STABLE}
Connection to peer device is not stable enough to communicate.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_SPIT_ERROR CAUSE_CONNECTION_SPIT_ERROR}
Connection error occurred in Android framework. The error message from the framework is appended to the value of extra field.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_THERE_IS_NO_DESTINATION_ON_PEER CAUSE_THERE_IS_NO_DESTINATION_ON_PEER}
The intent is not resolvable on the peer device. {@link #sendBroadcastOnPeer(IPeerIntent, IPeerIntent) sendBroadcastOnPeer()} does not broadcast any callback with this kind of cause.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_EXCEPTION_IS_THROWN_ON_PEER CAUSE_EXCEPTION_IS_THROWN_ON_PEER}
{@link android.content.Context#startActivity(android.content.Intent) startActivity()}, {@link android.content.Context#sendBroadcast(android.content.Intent) sendBroadcast()} or {@link android.content.Context#startService(android.content.Intent) startService()} throws an exception. The error message is appended to the value of extra field.
* @see android.content.Context#startActivity(android.content.Intent)
*/
void startActivityOnPeer(IPeerIntent intent, IPeerIntent successIntent, IPeerIntent errorIntent);
/**
* Sends broadcast on the peer device with given peer intent.
* In case of {@link #sendBroadcastOnPeer(IPeerIntent, IPeerIntent) sendBroadcastOnPeer()}, the intent is not checked if any broadcast receiver is able to
* receive the intent on the peer device. It means the intent may not be received by any broadcast
* receiver on the peer device and no errorIntent is broadcast to the local device.
*
* @param intent A peer intent for creating {@link android.content.Intent} which will
* be used for sending broadcast on the peer device.
* @param successIntent An Intent for callback. This intent will be broadcast to the local device if the request succeeds to process. It could be null.
* @param errorIntent An Intent for callback. This intent will be broadcast to the local device if the request fails to process. It could be null.
* errorIntent has an extra field with name {@link com.lge.qpair.api.r2.QPairConstants#EXTRA_CAUSE QPairConstants.EXTRA_CAUSE} and type String.
* Each value in the extra field represents the following meaning.
*
Value
Meaning
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_QPAIR_IS_OFF CAUSE_QPAIR_IS_OFF}
QPair is currently off.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_QPAIR_HAVE_INTERNAL_ERROR CAUSE_QPAIR_HAVE_INTERNAL_ERROR}
QPair got internal error.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_IS_NOT_AVAILABLE CAUSE_CONNECTION_IS_NOT_AVAILABLE}
Connection to the peer device is not available. The most possible reason is that Bluetooth does not turn on.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_IS_NOT_ESTABLISHED CAUSE_CONNECTION_IS_NOT_ESTABLISHED}
Connection to the peer device is not established. The most possible reason is that the peer device is not close enough to the local device.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_IS_NOT_STABLE CAUSE_CONNECTION_IS_NOT_STABLE}
Connection to peer device is not stable enough to communicate.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_SPIT_ERROR CAUSE_CONNECTION_SPIT_ERROR}
Connection error occurred in Android framework. The error message from the framework is appended to the value of extra field.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_THERE_IS_NO_DESTINATION_ON_PEER CAUSE_THERE_IS_NO_DESTINATION_ON_PEER}
The intent is not resolvable on the peer device. {@link #sendBroadcastOnPeer(IPeerIntent, IPeerIntent) sendBroadcastOnPeer()} does not broadcast any callback with this kind of cause.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_EXCEPTION_IS_THROWN_ON_PEER CAUSE_EXCEPTION_IS_THROWN_ON_PEER}
{@link android.content.Context#startActivity(android.content.Intent) startActivity()}, {@link android.content.Context#sendBroadcast(android.content.Intent) sendBroadcast()} or {@link android.content.Context#startService(android.content.Intent) startService()}
throws an exception. The error message is appended to the value of extra field.
* @see android.content.Context#sendBroadcast(android.content.Intent)
*/
void sendBroadcastOnPeer(IPeerIntent intent, IPeerIntent successIntent, IPeerIntent errorIntent);
/**
* Starts a service on peer device with given peer intent.
*
* @param intent A peer intent for creating {@link android.content.Intent} which will
* be used for starting service on the peer device.
* @param successIntent An Intent for callback. This intent will be broadcast to the local device if the request succeeds to process. It could be null.
* @param errorIntent An Intent for callback. This intent will be broadcast to the local device if the request fails to process. It could be null.
* errorIntent has an extra field with name {@link com.lge.qpair.api.r2.QPairConstants#EXTRA_CAUSE QPairConstants.EXTRA_CAUSE} and type String.
* Each value in the extra data represents the following meaning.
*
Value
Meaning
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_QPAIR_IS_OFF CAUSE_QPAIR_IS_OFF}
QPair is currently off.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_QPAIR_HAVE_INTERNAL_ERROR CAUSE_QPAIR_HAVE_INTERNAL_ERROR}
QPair got internal error.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_IS_NOT_AVAILABLE CAUSE_CONNECTION_IS_NOT_AVAILABLE}
Connection to the peer device is not available. The most possible reason is that Bluetooth does not turn on.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_IS_NOT_ESTABLISHED CAUSE_CONNECTION_IS_NOT_ESTABLISHED}
Connection to the peer device is not established. The most possible reason is that the peer device is not close enough to the local device.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_IS_NOT_STABLE CAUSE_CONNECTION_IS_NOT_STABLE}
Connection to peer device is not stable enough to communicate.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_SPIT_ERROR CAUSE_CONNECTION_SPIT_ERROR}
Connection error occurred in Android framework. The error message from the framework is appended to the value of extra field.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_THERE_IS_NO_DESTINATION_ON_PEER CAUSE_THERE_IS_NO_DESTINATION_ON_PEER}
The intent is not resolvable on the peer device. {@link #sendBroadcastOnPeer(IPeerIntent, IPeerIntent) sendBroadcastOnPeer()} does not broadcast any callback with this kind of cause.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_EXCEPTION_IS_THROWN_ON_PEER CAUSE_EXCEPTION_IS_THROWN_ON_PEER}
{@link android.content.Context#startActivity(android.content.Intent) startActivity()}, {@link android.content.Context#sendBroadcast(android.content.Intent) sendBroadcast()} or {@link android.content.Context#startService(android.content.Intent) startService()}
throws an exception. The error message is appended to the value of extra field.
* @see android.content.Context#startService(android.content.Intent)
*/
void startServiceOnPeer(IPeerIntent intent, IPeerIntent successIntent, IPeerIntent errorIntent);
/**
* Starts a service on the peer device with given peer intent after transferring file.
* If {@link com.lge.qpair.api.r2.IPeerIntent#getScheme} is not "file", then the file is not sent.
* If {@link com.lge.qpair.api.r2.IPeerIntent#getScheme} is "file", then the file obtained from
* {@link com.lge.qpair.api.r2.IPeerIntent#getDataString() IPeerIntent.getDataString()} is transferred to the peer device.
* On the peer device, the file is saved on
* android.os.Environment.getExternalStorageDirectory().getAbolutePath()
* + destinationFileName. If it is not possible, the file is saved on an arbitrary
* directory. The name of the saved file should be changed if there already exists a file with the same name.
* intent is used to start a service, after the data URI is
* replaced with the URI of transferred file on the peer device.
*
* @param intent A peer intent for creating {@link android.content.Intent} which will
* be used for starting a service on the peer device.
* @param destinationFileName the location to save the file.
It is used to determine the path which the
* transferred file is saved.
* @param successIntent An Intent for callback. This intent will be broadcast to the local device if the request succeeds to process. It could be null.
* @param errorIntent An Intent for callback. This intent will be broadcast to the local device if the request fails to process. It could be null.
* errorIntent has an extra data with name {@link com.lge.qpair.api.r2.QPairConstants#EXTRA_CAUSE QPairConstants.EXTRA_CAUSE} and type String.
* Each value in the extra data represents the following meaning.
*
Value
Meaning
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_QPAIR_IS_OFF CAUSE_QPAIR_IS_OFF}
QPair is currently off.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_QPAIR_HAVE_INTERNAL_ERROR CAUSE_QPAIR_HAVE_INTERNAL_ERROR}
QPair got internal error.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_IS_NOT_AVAILABLE CAUSE_CONNECTION_IS_NOT_AVAILABLE}
Connection to the peer device is not available. The most possible reason is that Bluetooth does not turned on.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_IS_NOT_ESTABLISHED CAUSE_CONNECTION_IS_NOT_ESTABLISHED}
Connection to the peer device is not established. The most possible reason is that the peer device is not close enough to the local device.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_IS_NOT_STABLE CAUSE_CONNECTION_IS_NOT_STABLE}
Connection to peer device is not stable enough to communicate.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_CONNECTION_SPIT_ERROR CAUSE_CONNECTION_SPIT_ERROR}
Connection error occurred in Android framework. The error message from the framework is appended to the value of extra field.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_THERE_IS_NO_DESTINATION_ON_PEER CAUSE_THERE_IS_NO_DESTINATION_ON_PEER}
The intent is not resolvable on the peer device. {@link #sendBroadcastOnPeer(IPeerIntent, IPeerIntent) sendBroadcastOnPeer()} does not broadcast any callback with this kind of cause.
{@link com.lge.qpair.api.r2.QPairConstants#CAUSE_EXCEPTION_IS_THROWN_ON_PEER CAUSE_EXCEPTION_IS_THROWN_ON_PEER}
{@link android.content.Context#startActivity(android.content.Intent) startActivity()}, {@link android.content.Context#sendBroadcast(android.content.Intent) sendBroadcast()} or {@link android.content.Context#startService(android.content.Intent) startService()}
throws an exception. The error message is appended to the value of extra field.
* @see android.content.Context#startService(android.content.Intent)
*/
//TODO 이 메소드에서만 나올 수 있는 cause 정리해서 추가
void startServiceOnPeerWithFile(IPeerIntent intent, String destinationFileName, IPeerIntent successIntent, IPeerIntent errorIntent);
}