RemoteLauncherOptions Class

  • Reference
Package:
com.microsoft.connecteddevices.remotesystems.commanding
  • java.lang.Object
    • NativeBase
      • com.microsoft.connecteddevices.remotesystems.commanding.RemoteLauncherOptions

public class RemoteLauncherOptions

This class specifies the options used to launch the default app for URI on a remote device.

Constructor Summary

Constructor Description
RemoteLauncherOptions()

Initializes an instance of this class with default values.

RemoteLauncherOptions(@Nullable String fallbackUri, @Nullable Collection<String> preferredPackageIds)

Initializes an instance of this class with the specified values.

Method Summary

Modifier and Type Method and Description
String getFallbackUri()

Returns the URI of the website to open in the event that the original URI cannot be handled by the intended app.

List<String> getPreferredPackageIds()

Returns an array of app / package identifiers that should be used to launch the URI on the remote device. These identifiers should be in a format that can be understood on the remote system (i.e. Package Family Name for Windows remote devices).

void setFallbackUri(@Nullable String fallbackUri)

Sets the URI of the website to open in the event that the original URI cannot be handled by the intended app.

void setPreferredPackageIds(@Nullable Collection<String> preferredPackageIds)

Sets the preferred app / package identifiers that should be used to launch the URI on the remote device. These identifiers should be in a format that can be understood on the remote system (i.e. Package Family Name for Windows remote devices).

Constructor Details

RemoteLauncherOptions

public RemoteLauncherOptions()

Initializes an instance of this class with default values.

RemoteLauncherOptions

public RemoteLauncherOptions(@Nullable String fallbackUri, @Nullable Collection preferredPackageIds)

Initializes an instance of this class with the specified values.

Parameters:

fallbackUri - The URI of the website to open in the event that the original URI cannot be handled by the intended app.
preferredPackageIds - A list of package IDs 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.

Method Details

getFallbackUri

public String getFallbackUri()

Returns the URI of the website to open in the event that the original URI cannot be handled by the intended app.

Returns:

The fallback URI String.

getPreferredPackageIds

public List getPreferredPackageIds()

Returns an array of app / package identifiers that should be used to launch the URI on the remote device. These identifiers should be in a format that can be understood on the remote system (i.e. Package Family Name for Windows remote devices).

Returns:

The array of preferred app identifiers.

setFallbackUri

public void setFallbackUri(@Nullable String fallbackUri)

Sets the URI of the website to open in the event that the original URI cannot be handled by the intended app.

Parameters:

fallbackUri - The fallback URI string.

setPreferredPackageIds

public void setPreferredPackageIds(@Nullable Collection preferredPackageIds)

Sets the preferred app / package identifiers that should be used to launch the URI on the remote device. These identifiers should be in a format that can be understood on the remote system (i.e. Package Family Name for Windows remote devices).

Parameters:

preferredPackageIds

Applies to