SubscribeOptions

AI-generated Key Takeaways

• SubscribeOptions configures calls to Messages.subscribe, controlling how your app receives nearby messages.

• Use SubscribeOptions.Builder to create an instance, setting a strategy, callback, and filter.

• Key properties include strategy, callback, and filter which dictate message delivery, handling, and selection respectively.

• It provides methods like getCallback(), getFilter(), and getStrategy() to access these configurations.

• A default DEFAULT instance is available for basic subscription scenarios.

public final class SubscribeOptions extends Object

Options for calls to Messages.subscribe(GoogleApiClient, PendingIntent).

Use the SubscribeOptions.Builder to create an instance of this class, e.g.:

SubscribeOptions options = new SubscribeOptions.Builder()
     .setStrategy(someStrategy)
     .setCallback(myCallback)
     .build();
 

Nested Class Summary

class

SubscribeOptions.Builder

Builder for instances of SubscribeOptions.

Field Summary

public static final SubscribeOptions

DEFAULT

Public Method Summary

SubscribeCallback	getCallback() Gets the subscription callback.
MessageFilter	getFilter() Gets the subscription filter.
Strategy	getStrategy() Gets the subscription strategy.
String	toString()

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()

Fields

public static final SubscribeOptions DEFAULT

Public Methods

public SubscribeCallback getCallback ()

Gets the subscription callback.

public MessageFilter getFilter ()

Gets the subscription filter.

public Strategy getStrategy ()

Gets the subscription strategy.

public String toString ()