markdown formatting for line returns
This commit is contained in:
Patrick Farley
Родитель
5392bf21a3
Коммит
9925c75004
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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,18 +26,18 @@ Initializes a new instance of the ConnectedDevicesException class with a message
|
|||
|
||||
`public ConnectedDevicesException(int independentError, int platformError, String message)`
|
||||
|
||||
**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
|
||||
**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
|
||||
|
||||
### ConnectedDevicesException
|
||||
Initializes a new instance of the ConnectedDevicesException class with a message, error codes, and a **Throwable** cause.
|
||||
|
||||
`public ConnectedDevicesException(int independentError, int platformError, String message, Throwable throwable)`
|
||||
|
||||
**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
|
||||
*throwable* - the cause of this exception
|
||||
**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
|
||||
*throwable* - the cause of 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
|
||||
|
|
|
|||
|
|
@ -11,8 +11,8 @@ Called within the **Platform.initialize** method when the Remote Systems platfor
|
|||
|
||||
`void fetchAuthCodeAsync(String url, Platform.IAuthCodeHandler handler)`
|
||||
|
||||
**Parameters**
|
||||
*url* - The URL that should be used to sign in the user with OAuth
|
||||
**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
|
||||
|
||||
### getClientId
|
||||
|
|
@ -20,5 +20,5 @@ Called within the **Platform.initialize** method when the Remote Systems platfor
|
|||
|
||||
`String getClientId()`
|
||||
|
||||
**Return value**
|
||||
**Return value**
|
||||
The client ID that represents the current application
|
||||
|
|
|
|||
|
|
@ -11,5 +11,5 @@ Called when the Remote Systems platform initialization process finishes.
|
|||
|
||||
`void onDone(boolean succeeded)`
|
||||
|
||||
**Parameters**
|
||||
**Parameters**
|
||||
*succeeded* - **true** if initialization was successful, otherwise **false**
|
||||
|
|
@ -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,5 +27,5 @@ 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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -11,5 +11,5 @@ Called when the Remote Systems platform is initializing and has acquired a new a
|
|||
|
||||
`void onAuthCodeFetched(String authCode)`
|
||||
|
||||
**Parameters**
|
||||
**Parameters**
|
||||
*authCode* - the previous authorization code that the system will attempt to refresh
|
||||
|
|
@ -16,9 +16,9 @@ Establishes the Remote Systems platform for use by the app.
|
|||
|
||||
`public static void initialize(Context context, final IAuthCodeProvider authCodeProvider, final IPlatformInitializationHandler initializationHandler)`
|
||||
|
||||
**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
|
||||
**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
|
||||
|
||||
### shutdown
|
||||
|
|
|
|||
|
|
@ -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,9 +11,9 @@ Starts the default app associated with the URI scheme name for the specified URI
|
|||
|
||||
`public void LaunchUriAsync(RemoteSystemConnectionRequest remoteSystemConnectionRequest, String uri, IRemoteLauncherListener listener) throws ConnectedDevicesException`
|
||||
|
||||
**Parameters**
|
||||
*remoteSystemConnectionRequest* - Specifies which remote system to connect to
|
||||
*uri* - The URI which will cause the launching of an app, according to its scheme
|
||||
**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
|
||||
|
||||
### LaunchUriAsync
|
||||
|
|
@ -21,10 +21,10 @@ Starts the default app associated with the URI scheme name for the specified URI
|
|||
|
||||
`public void LaunchUriAsync(RemoteSystemConnectionRequest remoteSystemConnectionRequest, String uri, RemoteLauncherOptions options, IRemoteLauncherListener listener) throws ConnectedDevicesException`
|
||||
|
||||
**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
|
||||
**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
|
||||
*listener* - The **IRemoteLauncherListener** to handle the outcome of this launch attempt
|
||||
|
||||
### LaunchUriAsync
|
||||
|
|
@ -32,9 +32,9 @@ Starts the default app associated with the URI scheme name for the specified URI
|
|||
|
||||
`public void LaunchUriAsync(RemoteSystemConnectionRequest remoteSystemConnectionRequest, String uri, RemoteLauncherOptions options, Bundle data, IRemoteLauncherListener listener) throws ConnectedDevicesException`
|
||||
|
||||
**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
|
||||
*data* - The input data for the app to handle upon launch
|
||||
**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
|
||||
*data* - The input data for the app to handle upon launch
|
||||
*listener* - The **IRemoteLauncherListener** to handle the outcome of this launch attempt
|
||||
|
|
@ -11,8 +11,8 @@ Initializes an instance of the RemoteLauncherOptions class.
|
|||
|
||||
`RemoteLauncherOptions(List<String> preferredAppIds, String fallbackUri)`
|
||||
|
||||
**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.
|
||||
**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
|
||||
|
||||
## Public methods
|
||||
|
|
@ -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 RemoteSystemKind getKind()`
|
||||
|
||||
**Return value**
|
||||
**Return value**
|
||||
The **RemoteSystemKind** 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**
|
||||
|
|
|
|||
|
|
@ -12,7 +12,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
|
||||
|
|
@ -22,5 +22,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 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**
|
||||
|
|
@ -10,7 +10,7 @@ An [**IRemoteSystemFilter**](IRemoteSystemFilter.md) that limits the set of disc
|
|||
Initializes an instance of the RemoteSystemKindFilter class with a list of string representations of device types to target.
|
||||
|
||||
`public RemoteSystemKindFilter(List<RemoteSystemKind> kinds`
|
||||
**Parameters**
|
||||
**Parameters**
|
||||
*kinds* - A list of string representations of the device types to target. These strings should conform to the values in the **RemoteSystemKind** enum.
|
||||
|
||||
## Public methods
|
||||
|
|
@ -20,7 +20,7 @@ Returns a list of the kinds of remote systems being targeted.
|
|||
|
||||
`public List<RemoteSystemKind> getKinds()`
|
||||
|
||||
**Return value**
|
||||
**Return value**
|
||||
A list of the kinds of remote systems being targeted.
|
||||
|
||||
### filter
|
||||
|
|
@ -28,9 +28,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**
|
||||
Загрузка…
Ссылка в новой задаче