Google is committed to advancing racial equity for Black communities. See how.

FenceUpdateRequest.Builder

public static class FenceUpdateRequest.Builder extends Object

Builder for a FenceUpdateRequest.

Public Constructor Summary

Public Method Summary

FenceUpdateRequest.Builder
addFence(String key, AwarenessFence fence, PendingIntent pendingIntent)
Adds a fence identified by the given key to get callbacks to the pendingIntent when triggered.
FenceUpdateRequest
build()
Builds the fence update request.
FenceUpdateRequest.Builder
removeFence(String key)
Removes the fence with the given key.
FenceUpdateRequest.Builder
removeFence(PendingIntent pendingIntent)
Removes all fences associated with the pendingIntent.

Inherited Method Summary

Public Constructors

public FenceUpdateRequest.Builder ()

Builder for a FenceUpdateRequest.

Public Methods

public FenceUpdateRequest.Builder addFence (String key, AwarenessFence fence, PendingIntent pendingIntent)

Adds a fence identified by the given key to get callbacks to the pendingIntent when triggered. To get data from the returned Intent, use the extract(Intent) utility method. If a fence with the given key already exists, then this new fence will replace the existing one, and any callbacks to a previous pending intent will cease.

Parameters
key The unique identifier for this fence, which can be used to either remove or replace the existing fence.
fence The fence that is to be registered.
pendingIntent The PendingIntent that receives callbacks whenever the fence's state changes. Use the extract(Intent) method to get details about the fence that was triggered.
Returns

public FenceUpdateRequest build ()

Builds the fence update request.

Returns

public FenceUpdateRequest.Builder removeFence (String key)

Removes the fence with the given key.

Parameters
key the key that was passed into addFence(String, AwarenessFence, PendingIntent) that identifies the fence to remove.
Returns

public FenceUpdateRequest.Builder removeFence (PendingIntent pendingIntent)

Removes all fences associated with the pendingIntent.

Parameters
pendingIntent The PendingIntent that was passed into addFence(String, AwarenessFence, PendingIntent).
Returns