Merged PR 2833: Merge android-june-updates to master
This commit is contained in:
Коммит
e18479b65c
|
@ -21,14 +21,17 @@ repositories {
|
|||
}
|
||||
|
||||
dependencies {
|
||||
compile(group: 'com.microsoft.connecteddevices', name: 'connecteddevices-sdk-armv7', version: '0.4.0', ext: 'aar', classifier: 'release')
|
||||
compile(group: 'com.microsoft.connecteddevices', name: 'connecteddevices-sdk-armeabi-v7a', version: '0.6.2', ext: 'aar', classifier: 'release')
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
If you wish to use ProGuard in your app, add the ProGuard Rules for these new APIs. Create a file called *proguard-rules.txt* in the *App* folder of your project, and paste in the contents of [ProGuard_Rules_for_Android_Rome_SDK.txt](../ProGuard_Rules_for_Android_Rome_SDK.txt).
|
||||
|
||||
In your project's *AndroidManifest.xml* file, add the following permissions inside the `<manifest>` element (if they are not already present). This gives your app permission to connect to the Internet.
|
||||
In your project's *AndroidManifest.xml* file, add the following permissions inside the `<manifest>` element (if they are not already present). This gives your app permission to connect to the Internet and to enable Bluetooth discovery on your device.
|
||||
|
||||
> Note: The Bluetooth-related permissions are only necessary for using Bluetooth discovery; they are not needed for the other features in the Connected Devices platform. Additionally, `ACCESS_COARSE_LOCATION` is only required on Android SDKs 21 and later. On Android SDKs 23 and later, the developer must also prompt the user to grant location access at runtime.
|
||||
|
||||
```xml
|
||||
<uses-permission android:name="android.permission.INTERNET" />
|
||||
<uses-permission android:name="android.permission.BLUETOOTH" />
|
||||
|
@ -62,10 +65,10 @@ Platform.initialize(getApplicationContext(),
|
|||
}
|
||||
|
||||
@Override
|
||||
// Connected Devices platform also needs the app id to initialize
|
||||
// Connected Devices platform also needs the app ID to initialize
|
||||
public String getClientId() {
|
||||
// recommended: retrieve app id previously and store as a global constant.
|
||||
// The app id is provided when you register your app on the Microsoft developer portal
|
||||
// recommended: retrieve app ID previously and store as a global constant.
|
||||
// The app ID is provided when you register your app on the Microsoft developer portal
|
||||
// (https://apps.dev.microsoft.com/)
|
||||
return APP_ID;
|
||||
}
|
||||
|
|
|
@ -1,23 +0,0 @@
|
|||
# AppServiceClientResponse class
|
||||
Represents information passed from a remote app service to the client app, namely the status of the last message sent by the client app and (optionally) a new message from the remote app service.
|
||||
|
||||
## Syntax
|
||||
`public final class AppServiceClientResponse`
|
||||
|
||||
## Public methods
|
||||
|
||||
### getMessage
|
||||
Retrieves the message sent by the remote app service, consisting of key/value pairs.
|
||||
|
||||
`public Bundle getMessage()`
|
||||
|
||||
**Return value**
|
||||
A [**Bundle**](https://developer.android.com/reference/android/os/Bundle.html) object containing String keys mapped to values of variable types.
|
||||
|
||||
### getStatus
|
||||
Retrieves the status of the last message sent from the client app to the remote app service.
|
||||
|
||||
`public AppServiceResponseStatus getStatus()`
|
||||
|
||||
**Return value**
|
||||
An [**AppServiceResponseStatus**](AppServiceResponseStatus.md) value describing the status of the most recent message sent to the remote app service (such as a reason why the message data was not delivered).
|
|
@ -1,22 +1,22 @@
|
|||
# AppServiceClientConnection class
|
||||
# AppServiceConnection class
|
||||
This class manages a connection to an app service on a remote device.
|
||||
|
||||
## Syntax
|
||||
`public final class AppServiceClientConnection`
|
||||
`public final class AppServiceConnection`
|
||||
|
||||
## Public constructors
|
||||
|
||||
### AppServiceClientConnection
|
||||
Initializes an instance of the AppServiceClientConnection class with a name and Id of the app service, a generic remote connection request, and a listeners for related connection events.
|
||||
### AppServiceConnection
|
||||
Initializes an instance of the AppServiceConnection class with a name and Id of the app service, a generic remote connection request, and a listeners for related connection events.
|
||||
|
||||
`public AppServiceClientConnection(String appServiceName, String appIdentifier, RemoteSystemConnectionRequest request, IAppServiceClientConnectionListener appServiceClientConnectionListener, IAppServiceResponseListener responseListener) throws InvalidParameterException`
|
||||
`public AppServiceConnection(String appServiceName, String appIdentifier, RemoteSystemConnectionRequest request, IAppServiceConnectionListener appServiceConnectionListener, IAppServiceRequestListener requestListener) throws InvalidParameterException`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*appServiceName* - the name of the remote app service. [See Create and consume an app service](https://docs.microsoft.com/en-us/windows/uwp/launch-resume/how-to-create-and-consume-an-app-service) for details.
|
||||
*appIdentifier* - the package family name of the remote app service. See [See Create and consume an app service](https://docs.microsoft.com/en-us/windows/uwp/launch-resume/how-to-create-and-consume-an-app-service) for details.
|
||||
*request* - a [**RemoteSystemConnectionRequest**](RemoteSystemConnectionRequest.md) object representing the intent to connect to a specific remote system
|
||||
*appServiceClientConnectionListener* - an [**IAppServiceClientConnectionListener**](IAppServiceClientConnectionListener.md) that handles events related to the connection itself.
|
||||
*responseListener* - an [**IAppServiceResponseListener**](IAppServiceResponseListener.md) that handles messaging events with the remote app service
|
||||
*appServiceConnectionListener* - an [**IAppServiceConnectionListener**](IAppServiceConnectionListener.md) that handles events related to the connection itself.
|
||||
*requestListener* - an [**IAppServiceRequestListener**](IAppServiceRequestListener.md) that handles incoming app service requests over the remote app service connection.
|
||||
|
||||
## Public methods
|
||||
|
||||
|
@ -28,10 +28,11 @@ Opens a connection to the remote app service specified in this class' constructo
|
|||
### sendMessageAsync
|
||||
Sends a message to the connected remote app service consisting of key/value pairs.
|
||||
|
||||
`public void sendMessageAsync(Bundle messageBundle) throws ConnectedDevicesException`
|
||||
`public void sendMessageAsync(Bundle messageBundle, IAppServiceResponseListener responseListener) throws ConnectedDevicesException`
|
||||
|
||||
**Parameters**
|
||||
*messageBundle* - a [**Bundle**](https://developer.android.com/reference/android/os/Bundle.html) object containing String keys mapped to values of variable types
|
||||
#### Parameters
|
||||
*messageBundle* - a [**Bundle**](https://developer.android.com/reference/android/os/Bundle.html) object containing String keys mapped to values of variable types
|
||||
*responseListener* - an [**IAppServiceResponseListener**](IAppServiceResponseListener.md) that handles the receipt of the remote app service's response to the message being sent.
|
||||
|
||||
### closeAsync
|
||||
Closes the connection to the remote app service. This is recommended when the client app closes or stops.
|
||||
|
@ -39,17 +40,17 @@ Closes the connection to the remote app service. This is recommended when the cl
|
|||
`public void closeAsync()`
|
||||
|
||||
### getAppServiceName
|
||||
Returns the app service name with which this AppServiceClientConnection instance was constructed.
|
||||
Returns the app service name with which this AppServiceConnection instance was constructed.
|
||||
|
||||
`public String getAppServiceName()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The name string of the target app service.
|
||||
|
||||
### getPackageFamilyName
|
||||
Returns the package family name with which this AppServiceClientConnection instance was constructed.
|
||||
Returns the package family name with which this AppServiceConnection instance was constructed.
|
||||
|
||||
`public String getPackageFamilyName()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The package family name string of the target app service.
|
|
@ -1,4 +1,4 @@
|
|||
# AppServiceClientConnectionClosedStatus
|
||||
# AppServiceConnectionClosedStatus
|
||||
Contains the values that describe the reason that an app service connection was closed.
|
||||
|
||||
## Fields
|
||||
|
@ -13,9 +13,9 @@ Contains the values that describe the reason that an app service connection was
|
|||
## Public methods
|
||||
|
||||
### getValue
|
||||
Returns the int value for this AppServiceClientConnectionClosedStatus.
|
||||
Returns the int value for this AppServiceConnectionClosedStatus.
|
||||
|
||||
`public int getValue()`
|
||||
|
||||
**Return value**
|
||||
The int value for this AppServiceClientConnectionClosedStatus
|
||||
#### return value
|
||||
The int value for this AppServiceConnectionClosedStatus
|
|
@ -1,4 +1,4 @@
|
|||
# AppServiceClientConnectionStatus enum
|
||||
# AppServiceConnectionStatus enum
|
||||
Contains the values that describe a connection to a remote app service.
|
||||
|
||||
## Fields
|
||||
|
@ -17,9 +17,9 @@ Contains the values that describe a connection to a remote app service.
|
|||
## Public methods
|
||||
|
||||
### getValue
|
||||
Returns the int value for this AppServiceClientConnectionStatus.
|
||||
Returns the int value for this AppServiceConnectionStatus.
|
||||
|
||||
`public int getValue()`
|
||||
|
||||
**Return value**
|
||||
The int value for this AppServiceClientConnectionStatus
|
||||
#### return value
|
||||
The int value for this AppServiceConnectionStatus
|
|
@ -0,0 +1,24 @@
|
|||
# AppServiceRequest class
|
||||
Represents a message sent from one app service to another over a remote app service connection.
|
||||
|
||||
## Syntax
|
||||
`public final class AppServiceRequest`
|
||||
|
||||
## Public methods
|
||||
|
||||
### getMessage
|
||||
Retrieves the message that was sent, consisting of key/value pairs.
|
||||
|
||||
`public Bundle getMessage()`
|
||||
|
||||
#### return value
|
||||
A [**Bundle**](https://developer.android.com/reference/android/os/Bundle.html) object containing String keys mapped to values of variable types.
|
||||
|
||||
### sendResponseAsync
|
||||
Sends a response message to the remote app service that sent the original message.
|
||||
|
||||
`public void sendResponseAsync(Bundle response, IAppServiceResponseStatusListener listener)`
|
||||
|
||||
#### Parameters
|
||||
*response* - A [**Bundle**](https://developer.android.com/reference/android/os/Bundle.html) object containing the data to be sent.
|
||||
*listener* - The listener that will handle a status report on the response message being sent by this method.
|
|
@ -0,0 +1,23 @@
|
|||
# AppServiceResponse class
|
||||
Represents a message passed from a remote app service to the client app in response to a previously sent message.
|
||||
|
||||
## Syntax
|
||||
`public final class AppServiceResponse`
|
||||
|
||||
## Public methods
|
||||
|
||||
### getMessage
|
||||
Retrieves the message sent by the remote app service, consisting of key/value pairs.
|
||||
|
||||
`public Bundle getMessage()`
|
||||
|
||||
#### return value
|
||||
A [**Bundle**](https://developer.android.com/reference/android/os/Bundle.html) object containing String keys mapped to values of variable types.
|
||||
|
||||
### getStatus
|
||||
Retrieves the status of the response from the remote app service.
|
||||
|
||||
`public AppServiceResponseStatus getStatus()`
|
||||
|
||||
#### return value
|
||||
An [**AppServiceResponseStatus**](AppServiceResponseStatus.md) value describing the status of the response.
|
|
@ -1,5 +1,5 @@
|
|||
# AppServiceResponseStatus enum
|
||||
Contains values that describe the status of a message sent from the client app to a remote app service (whether the message data was successfully delivered).
|
||||
Contains values that describe the status of a message sent from one app service to another (whether the message data was successfully delivered).
|
||||
|
||||
## Fields
|
||||
|
||||
|
@ -19,5 +19,5 @@ Returns the int value for this AppServiceResponseStatus.
|
|||
|
||||
`public int getValue()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The int value for this AppServiceResponseStatus
|
|
@ -16,10 +16,10 @@ Gets the ConnectedDevicesError for the given value.
|
|||
|
||||
`public static ConnectedDevicesError fromInt(int value)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*value* - the value representing a ConnectedDevicesError
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The ConnectedDevicesError for the given value.
|
||||
|
||||
### getValue
|
||||
|
@ -27,5 +27,5 @@ Gets the integer value of this ConnectedDevicesError instance
|
|||
|
||||
`public int getValue()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The integer value of this instance
|
|
@ -18,7 +18,7 @@ Initializes a new instance of the ConnectedDevicesException class with a message
|
|||
|
||||
`public ConnectedDevicesException(String message)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*message* - the message for this exception
|
||||
|
||||
### ConnectedDevicesException
|
||||
|
@ -26,7 +26,7 @@ Initializes a new instance of the ConnectedDevicesException class with a message
|
|||
|
||||
`public ConnectedDevicesException(int independentError, int platformError, String message)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*independentError* - the Remote Systems error code for this exception
|
||||
*platformError* - the Android system error code for this exception
|
||||
*message* - the message for this exception
|
||||
|
@ -36,7 +36,7 @@ Initializes a new instance of the ConnectedDevicesException class with a message
|
|||
|
||||
`public ConnectedDevicesException(int independentError, int platformError, String message, Throwable throwable)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*independentError* - the Remote Systems error code for this exception
|
||||
*platformError* - the Android system error code for this exception
|
||||
*message* - the message for this exception
|
||||
|
|
|
@ -23,7 +23,7 @@ The value of the Android device platform error
|
|||
|
||||
`public boolean isSuccess()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
**true** if this instance represents a success, **false** if not
|
||||
|
||||
### isFailure
|
||||
|
@ -31,5 +31,5 @@ Determines whether the instance represents a failed result.
|
|||
|
||||
`public boolean isFailure()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
**true** if this instance represents a failure, **false** if not
|
||||
|
|
|
@ -1,28 +0,0 @@
|
|||
# IAppServiceClientConnectionListener interface
|
||||
Contains methods that handle events related to the connection to a remote app service.
|
||||
|
||||
## Syntax
|
||||
`public interface IAppServiceClientConnectionListener`
|
||||
|
||||
## Public methods
|
||||
|
||||
### onSuccess
|
||||
Called when the connection to a remote app service was established successfully.
|
||||
|
||||
`void onSuccess()`
|
||||
|
||||
### onError
|
||||
Called when the Connected Devices platform failed to establish a connection to a remote app service.
|
||||
|
||||
`void onError(AppServiceClientConnectionStatus status)`
|
||||
|
||||
**Parameters**
|
||||
*status* - an [**AppServiceClientConnectionStatus**](AppServiceClientConnectionStatus.md) value describing the status of the connection (the cause of the error).
|
||||
|
||||
### onClosed
|
||||
Called when the connection to a remote app service is closed.
|
||||
|
||||
`void onClosed(AppServiceClientConnectionClosedStatus status)`
|
||||
|
||||
**Parameters**
|
||||
*statues* - an [**AppServiceClientConnectionClosedStatus**](AppServiceClientConnectionClosedStatus.md) value describing the reason the app service connection was closed.
|
|
@ -0,0 +1,28 @@
|
|||
# IAppServiceConnectionListener interface
|
||||
Contains methods that handle events related to the connection to a remote app service.
|
||||
|
||||
## Syntax
|
||||
`public interface IAppServiceConnectionListener`
|
||||
|
||||
## Public methods
|
||||
|
||||
### onSuccess
|
||||
Called when the connection to a remote app service was established successfully.
|
||||
|
||||
`void onSuccess()`
|
||||
|
||||
### onError
|
||||
Called when the Remote Systems platform failed to establish a connection to a remote app service.
|
||||
|
||||
`void onError(AppServiceConnectionStatus status)`
|
||||
|
||||
#### Parameters
|
||||
*status* - an [**AppServiceConnectionStatus**](AppServiceConnectionStatus.md) value describing the status of the connection (the cause of the error).
|
||||
|
||||
### onClosed
|
||||
Called when the connection to a remote app service is closed.
|
||||
|
||||
`void onClosed(AppServiceConnectionClosedStatus status)`
|
||||
|
||||
#### Parameters
|
||||
*statues* - an [**AppServiceConnectionClosedStatus**](AppServiceConnectionClosedStatus.md) value describing the reason the app service connection was closed.
|
|
@ -0,0 +1,15 @@
|
|||
# IAppServiceRequestListener interface
|
||||
Handles the receiving of incoming app service requests over the remote app service connection.
|
||||
|
||||
## Syntax
|
||||
`public interface IAppServiceRequestListener`
|
||||
|
||||
## Public methods
|
||||
|
||||
### requestReceived
|
||||
Called when a request for remote app service connectivity has been received through the Remote Systems platform.
|
||||
|
||||
`void requestReceived(AppServiceRequest request)`
|
||||
|
||||
#### Parameters
|
||||
*request* - an [**AppServiceRequest**](AppServiceRequest.md) instance representing the service request from a remote app service.
|
|
@ -1,5 +1,5 @@
|
|||
# IAppServiceResponseListener interface
|
||||
Handles the receiving of information from a remote app service.
|
||||
Handles the receiving of a message sent from a remote app service in response to a previously sent message.
|
||||
|
||||
## Syntax
|
||||
`public interface IAppServiceResponseListener`
|
||||
|
@ -7,9 +7,9 @@ Handles the receiving of information from a remote app service.
|
|||
## Public methods
|
||||
|
||||
### responseReceived
|
||||
Called when a response from a remote app service has been received through the Connected Devices platform.
|
||||
Called when a response from a remote app service has been received through the Remote Systems platform.
|
||||
|
||||
`void responseReceived(AppServiceClientResponse response)`
|
||||
`void responseReceived(AppServiceResponse response)`
|
||||
|
||||
**Parameters**
|
||||
*response* - an [**AppServiceClientResponse**](AppServiceClientResponse.md) instance representing the app service's response.
|
||||
#### Parameters
|
||||
*response* - an [**AppServiceResponse**](AppServiceResponse.md) instance representing the app service's response.
|
|
@ -0,0 +1,15 @@
|
|||
# IAppServiceResponseStatusListener interface
|
||||
Handles the receiving of a status report on an outgoing app service response message.
|
||||
|
||||
## Syntax
|
||||
`public interface IAppServiceResponseStatusListener`
|
||||
|
||||
## Public methods
|
||||
|
||||
### statusReceived
|
||||
Called when a status report has been received.
|
||||
|
||||
`void statusReceived(AppServiceResponseStatus status)`
|
||||
|
||||
#### Parameters
|
||||
*status* - an [**AppServiceResponseStatus**](AppServiceResponseStatus.md) value representing the status of the sent response.
|
|
@ -11,7 +11,7 @@ Called within the **Platform.initialize** method when the Remote Systems platfor
|
|||
|
||||
`void fetchAuthCodeAsync(String url, Platform.IAuthCodeHandler handler)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*url* - The URL that should be used to sign in the user with OAuth
|
||||
*handler* - The handler that the app will later invoke with the new auth code
|
||||
|
||||
|
@ -20,5 +20,5 @@ Called within the **Platform.initialize** method when the Remote Systems platfor
|
|||
|
||||
`String getClientId()`
|
||||
|
||||
**Return value**
|
||||
#### Return value
|
||||
The ID that represents the current application
|
||||
|
|
|
@ -11,5 +11,5 @@ Called when the remote URI launch has completed.
|
|||
|
||||
`void onCompleted(RemoteLauncherUriStatus status)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*status* - the status of the remote launch
|
|
@ -11,7 +11,7 @@ Called when a remote system is discovered.
|
|||
|
||||
`void onRemoteSystemAdded(RemoteSystem remoteSystem)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*remoteSystem* - a **RemoteSystem** object representing the discovered device.
|
||||
|
||||
### onRemoteSystemUpdated
|
||||
|
@ -19,7 +19,7 @@ Called when a previously discovered remote system has been updated as being avai
|
|||
|
||||
`void onRemoteSystemUpdated(RemoteSystem remoteSystem)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*remoteSystem* - the **RemoteSystem** object representing the device that was updated
|
||||
|
||||
### onRemoteSystemRemoved
|
||||
|
@ -27,7 +27,7 @@ Called when a previously discovered remote system is no longer available.
|
|||
|
||||
`void onRemoteSystemRemoved(String remoteSystemId)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*remoteSystemId* - the unique device id of the removed remote system
|
||||
|
||||
### onComplete
|
||||
|
|
|
@ -11,5 +11,5 @@ Called to check whether a **RemoteSystem** passes through the implemented filter
|
|||
|
||||
`boolean filter (RemoteSystem remoteSystem)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*remoteSystem* - the **RemoteSystem** object to check against the filter
|
|
@ -7,9 +7,9 @@ Provides a method for getting an authorization token, as part of the platform in
|
|||
## Public methods
|
||||
|
||||
### onAuthCodeFetched
|
||||
Called by the Connected Devices platform when it is initializing and has acquired a new authorization code.
|
||||
Called by the Remote Systems platform when it is initializing and has acquired a new authorization code.
|
||||
|
||||
`void onAuthCodeFetched(String authCode)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*authCode* - the previous authorization code that the system will attempt to refresh
|
|
@ -16,7 +16,7 @@ Establishes the Remote Systems platform for use by the app.
|
|||
|
||||
`public static void initialize(Context context, final IAuthCodeProvider authCodeProvider, final IPlatformInitializationHandler initializationHandler)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*context* - the **Context** for the current application
|
||||
*authCodeProvider* - an implementation of [**IAuthCodeProvider**](IAuthCodeProvider.md) that can deliver the required authentication information for this app
|
||||
*initializationHandler* - an implementation of [**IPlatformInitializationHandler**](IPlatformInitializationHandler.md) that determines what is done when this method succeeds or fails
|
||||
|
|
|
@ -21,6 +21,6 @@ Returns the int value for this RemoteLaunchUriStatus.
|
|||
|
||||
`public int getValue()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The int value for this RemoteLaunchUriStatus
|
||||
|
||||
|
|
|
@ -11,7 +11,7 @@ Starts the default app associated with the URI scheme name for the specified URI
|
|||
|
||||
`public static void LaunchUriAsync(RemoteSystemConnectionRequest remoteSystemConnectionRequest, String uri, IRemoteLauncherListener listener) throws ConnectedDevicesException`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*remoteSystemConnectionRequest* - Specifies which remote system to connect to
|
||||
*uri* - The URI which will cause the launching of an app, according to its scheme
|
||||
*listener* - The **IRemoteLauncherListener** to handle the outcome of this launch attempt
|
||||
|
@ -21,7 +21,7 @@ Starts the default app associated with the URI scheme name for the specified URI
|
|||
|
||||
`public static void LaunchUriAsync(RemoteSystemConnectionRequest remoteSystemConnectionRequest, String uri, RemoteLauncherOptions options, IRemoteLauncherListener listener) throws ConnectedDevicesException`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*remoteSystemConnectionRequest* - Specifies which remote system to connect to
|
||||
*uri* - The URI which will cause the launching of an app, according to its scheme
|
||||
*options* - The launch specifications for the app
|
||||
|
|
|
@ -11,7 +11,7 @@ Initializes an instance of the RemoteLauncherOptions class.
|
|||
|
||||
`RemoteLauncherOptions(List<String> preferredAppIds, String fallbackUri)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*preferredAppIds* - a list of global identifiers of apps that should be used to launch the URI on the remote device. The first string on the list should correspond to the preferred application.
|
||||
*fallbackUri* - The URI of the web site to open in the event that the original URI cannot be handled by the intended app
|
||||
|
||||
|
@ -22,7 +22,7 @@ Returns the URI of the web site to open in the event that the original URI canno
|
|||
|
||||
`public String getFallbackUri()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The fallback URI String
|
||||
|
||||
### getPreferredAppIds
|
||||
|
@ -30,5 +30,5 @@ Returns the list of global identifiers of apps that should be used to launch the
|
|||
|
||||
`public List<String> getPreferredAppIds()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The list of preferred app identifiers
|
||||
|
|
|
@ -11,7 +11,7 @@ Returns the "friendly name" of the remote system.
|
|||
|
||||
`public String getDisplayName()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The "friendly name" of the remote system
|
||||
|
||||
### getKind
|
||||
|
@ -19,7 +19,7 @@ Returns the kind of the remote system.
|
|||
|
||||
`public RemoteSystemKinds getKind()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The **RemoteSystemKinds** value corresponding to the kind of device this remote system is classified as
|
||||
|
||||
### getStatus
|
||||
|
@ -27,7 +27,7 @@ Returns the status of the remote system.
|
|||
|
||||
`public RemoteSystemStatus getStatus()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The **RemoteSystemStatus** value representing the remote system's availability status
|
||||
|
||||
### getId
|
||||
|
@ -35,7 +35,7 @@ Returns the unique device id of the remote system.
|
|||
|
||||
`public String getId()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The unique device id of the remote system
|
||||
|
||||
### isAvailableByProximity
|
||||
|
@ -43,7 +43,7 @@ Checks whether the device is available by either UDP or Bluetooth.
|
|||
|
||||
`public boolean isAvailableByProximity()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
**true** if the the device is available by UDP or Bluetooth, otherwise **false**
|
||||
|
||||
### isAvailableByCloud
|
||||
|
@ -51,5 +51,5 @@ Checks whether the device is available cloud connection.
|
|||
|
||||
`public boolean isAvailableByCloud()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
**true** if the the device is available by cloud connection, otherwise **false**
|
||||
|
|
|
@ -13,7 +13,7 @@ Initializes a new instance of the RemoteSystemConnectionRequest class for a part
|
|||
|
||||
`public RemoteSystemConnectionRequest(RemoteSystem remote)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*remote* - the **RemoteSystem** object to attempt to connect to.
|
||||
|
||||
## Public methods
|
||||
|
@ -23,5 +23,5 @@ Retrieves the **RemoteSystem** object for this particular connection request.
|
|||
|
||||
`public RemoteSystem getRemoteSystem()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The **RemoteSystem** object for this particular connection request
|
||||
|
|
|
@ -16,7 +16,7 @@ Gets the integer value of this RemoteSystemConnectionType instance
|
|||
|
||||
`public int getValue()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The integer value of this instance
|
||||
|
||||
### fromInt
|
||||
|
@ -24,10 +24,10 @@ Gets the ConnectedDevicesError for the given value.
|
|||
|
||||
`public static ConnectedDevicesError fromInt(int value)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*value* - the value representing a ConnectedDevicesError
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The ConnectedDevicesError for the given value.
|
||||
|
||||
### listFromInt
|
||||
|
@ -35,10 +35,10 @@ Returns a list of RemoteSystemConnectionType instances for the array of values p
|
|||
|
||||
`public static List<RemoteSystemConnectionType> listFromInt(int[] values)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*values* - an array of integer values corresponding to RemoteSystemConnectionType values
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
A list of RemoteSystemConnectionType instances corresponding to the values provided. Returns an empty list if *values* does not contain any valid values.
|
||||
|
||||
|
||||
|
|
|
@ -11,10 +11,10 @@ Adds an **IRemoteSystemFilter** to this builder's list of filters and returns th
|
|||
|
||||
`public Builder filter(IRemoteSystemFilter filter)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*filter* - the **IRemoteSystemFilter** to add
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
This builder object
|
||||
|
||||
### setListener
|
||||
|
@ -22,10 +22,10 @@ Sets an **IRemoteSystemDiscoveryListener** to handle the discovery events that t
|
|||
|
||||
`public Builder setListener(IRemoteSystemDiscoveryListener listener)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*listener* - the **IRemoteSystemDiscoveryListener** to handle discovery events
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
This builder object
|
||||
|
||||
### getResult
|
||||
|
@ -33,5 +33,5 @@ Creates and returns the **RemoteSystemDiscovery** object from this builder, with
|
|||
|
||||
`public RemoteSystemDiscovery getResult()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The **RemoteSystemDiscovery** object created by this builder
|
|
@ -26,5 +26,5 @@ Attempts to discover a device using an identifying string
|
|||
|
||||
`public void findByHostName(String hostname) throws ConnectedDevicesException`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*hostname* - the IP address or the machine name of the targeted remote device
|
|
@ -12,7 +12,7 @@ Initializes an instance of the RemoteSystemDiscoveryTypeFilter class.
|
|||
|
||||
`public public RemoteSystemDiscoveryTypeFilter(RemoteSystemDiscoveryType type)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*type* - the discovery type to target.
|
||||
|
||||
## Public methods
|
||||
|
@ -22,7 +22,7 @@ Returns the discovery type being targeted.
|
|||
|
||||
`public RemoteSystemDiscoveryType getType()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The discovery type being targeted
|
||||
|
||||
### filter
|
||||
|
@ -30,8 +30,8 @@ Checks whether a remote system passes through the filter.
|
|||
|
||||
`public boolean filter(RemoteSystem remoteSystem)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*remoteSystem* - the **RemoteSystem** to check
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
**true** if *remoteSystem* passes, otherwise **false**
|
|
@ -11,7 +11,7 @@ Initializes an instance of the RemoteSystemKindFilter class with a list of strin
|
|||
|
||||
`public RemoteSystemKindFilter(List<RemoteSystemKinds> kinds)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*kinds* - A list of string representations of the device types to target. These strings should conform to the values in the **RemoteSystemKinds** enum.
|
||||
|
||||
## Public methods
|
||||
|
@ -21,7 +21,7 @@ Returns a list of the kinds of remote systems being targeted.
|
|||
|
||||
`public List<RemoteSystemKinds> getKinds()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
A list of the kinds of remote systems being targeted.
|
||||
|
||||
### filter
|
||||
|
@ -29,9 +29,9 @@ Check whether a remote system passes through the filter.
|
|||
|
||||
`public boolean filter(RemoteSystem remoteSystem)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*filter* - the **RemoteSystem** to check
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
**true** if *remoteSystem* passes, otherwise **false**
|
||||
|
|
@ -11,7 +11,7 @@ Initializes an instance of the **RemoteSystemStatusTypeFilter** class.
|
|||
|
||||
`public RemoteSystemStatusTypeFilter(RemoteSystemStatusType type)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*type* - the status type to target.
|
||||
|
||||
## Public methods
|
||||
|
@ -21,7 +21,7 @@ Returns the status type being targeted.
|
|||
|
||||
`public RemoteSystemStatusType getType()`
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
The status type being targeted
|
||||
|
||||
### filter
|
||||
|
@ -29,8 +29,8 @@ Checks whether a remote system passes through the filter.
|
|||
|
||||
`public boolean filter(RemoteSystem remoteSystem)`
|
||||
|
||||
**Parameters**
|
||||
#### Parameters
|
||||
*remoteSystem* - the **RemoteSystem** to check
|
||||
|
||||
**Return value**
|
||||
#### return value
|
||||
**true** if *remoteSystem* passes, otherwise **false**
|
Загрузка…
Ссылка в новой задаче