ConnectionOptions

AI-generated Key Takeaways

• ConnectionOptions are used for specifying options when requesting a connection using ConnectionsClient.

• The class includes a Builder for creating ConnectionOptions instances.

• Key methods allow getting the connection type, determining if low power mode is preferred, and converting connection types to strings.

• The getDisruptiveUpgrade method is deprecated; getConnectionType should be used instead.

public final class ConnectionOptions extends Object
implements Parcelable

Options for a call to ConnectionsClient.requestConnection(byte[], String, ConnectionLifecycleCallback).

Nested Class Summary

class

ConnectionOptions.Builder

Builder class for ConnectionOptions.

Inherited Constant Summary

From interface android.os.Parcelable

int	CONTENTS_FILE_DESCRIPTOR
int	PARCELABLE_WRITE_RETURN_VALUE

Field Summary

public static final Creator<ConnectionOptions>

CREATOR

Public Method Summary

static String	convertConnectionTypeToString(int connectionType) Converts the ConnectionType to a string.
boolean	equals(Object other)
int	getConnectionType() Returns the ConnectionType which indicate the client prefer or not prefer to disrupt the current Wi-Fi or Bluetooth connections.
boolean	getDisruptiveUpgrade() This method is deprecated. Use getConnectionType() instead.
boolean	getLowPower() Gets whether to attempt to connect with the lowest possible power (like BLE) if true.
int	hashCode()
String	toString()
void	writeToParcel(Parcel dest, int flags)

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface android.os.Parcelable

abstract int	describeContents()
abstract void	writeToParcel(Parcel arg0, int arg1)

Fields

public static final Creator<ConnectionOptions> CREATOR

Public Methods

public static String convertConnectionTypeToString (int connectionType)

Converts the ConnectionType to a string.

public boolean equals (Object other)

public int getConnectionType ()

Returns the ConnectionType which indicate the client prefer or not prefer to disrupt the current Wi-Fi or Bluetooth connections. The default is ConnectionType.BALANCED.

public boolean getDisruptiveUpgrade ()

This method is deprecated.
Use getConnectionType() instead.

Gets the disruptive upgrade flag. A disruptive upgrade may disconnect the device from its primary Wi-Fi network, or otherwise modify Wi-Fi and/or BT state to optimize for faster throughput. By default, this option is true.

public boolean getLowPower ()

Gets whether to attempt to connect with the lowest possible power (like BLE) if true. By default, this option is false.

public int hashCode ()

public String toString ()

public void writeToParcel (Parcel dest, int flags)