LocationSharing (Meridian API)

java.lang.Object
- com.arubanetworks.meridian.locationsharing.LocationSharing

public class LocationSharing
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LocationSharing.Callback<T>` Callback interface for Location Sharing operations
`static interface`	`LocationSharing.Listener`
`static class`	`LocationSharing.Mode`
`protected static class`	`LocationSharing.RegisterJobAgainEvent`

Constructor Summary

Constructors
Constructor and Description

LocationSharing()

Constructors
Constructor and Description
`LocationSharing()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acceptInvite(java.lang.String inviteKey, LocationSharing.Callback<Friend> callback)` Accepts an invite, creating a friendship between the current user and the invite creator.
`void`	`addListener(LocationSharing.Listener listener)` Set a listener if you want to know when Location Sharing starts / stops updating user locations
`void`	`createInvite(LocationSharing.Callback<Invite> callback)` Creates a new invite An user must be logged in (see `setCurrentUser()`)
`void`	`createUser(User user, LocationSharing.Callback<User> callback)` Creates a new location sharing user.
`void`	`deleteProfile(android.content.Context context, LocationSharing.Callback<java.lang.Void> callback)` Deletes current user’s profile
`EditorKey`	`getAppKey()` Gets the current App Key
`User`	`getCurrentUser()` Call this method to get the current logged in user
`void`	`getFriends(LocationSharing.Callback<java.util.List<Friend>> callback)` Retrieves list of friends for the current user An user must be logged in (see `setCurrentUser()`)
`void`	`getInvites(LocationSharing.Callback<java.util.List<Invite>> callback)` Retrieves all invites created by the current user An user must be logged in (see `setCurrentUser()`)
`LocationSharing.Mode`	`getMode()` Gets the current Location Sharing mode (FOREGROUND or BACKGROUND).
`android.app.PendingIntent`	`getStopPendingIntent(android.content.Context context)` Creates a PendingIntent to stop uploading user’s location.
`static void`	`initWithAppKey(EditorKey appKey)` Call this method to initialize Location Sharing.
`boolean`	`isUploadingServiceRunning()` Checks if the upload location service is currently running
`void`	`onRegisterJobAgainEvent(LocationSharing.RegisterJobAgainEvent event)`
`void`	`removeFriend(java.lang.String friendId, LocationSharing.Callback<java.lang.Void> callback)` Removes friendship between current user and provided friend id An user must be logged in (see `setCurrentUser()`)
`void`	`removeListener(LocationSharing.Listener listener)` Removes a listener
`void`	`removeUserPhoto(LocationSharing.Callback<User> callback)` Removes profile pic for the current user An user must be logged in (see `setCurrentUser()`)
`void`	`revokeAllInvites(LocationSharing.Callback<java.lang.Void> callback)` Revokes all invites create by the current user An user must be logged in (see `setCurrentUser()`)
`void`	`setAppKey(EditorKey appKey)` Sets the current App Key
`void`	`setCurrentUser(User currentUser)` Call this method to set the current logged in user
`void`	`setMode(LocationSharing.Mode mode)` Location Sharing can run in two modes, FOREGROUND and BACKGROUND.
`static LocationSharing`	`shared()` Call this method to get a valid LocationSharing instance.
`boolean`	`startPostingLocationUpdates(android.content.Context context)` Start uploading user’s location
`void`	`stopPostingLocationUpdates(android.content.Context context)` Stop uploading user’s location
`void`	`updateUser(User user, LocationSharing.Callback<User> callback)` Updates a new location sharing user.
`void`	`uploadUserPhoto(android.content.Context context, android.net.Uri photoUri, LocationSharing.Callback<User> callback)` Uploads a photo for the current user An user must be logged in (see `setCurrentUser()`)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LocationSharing
```
public LocationSharing()
```
- Method Detail
  - initWithAppKey
```
public static void initWithAppKey(EditorKey appKey)
```
    Call this method to initialize Location Sharing.
    
    Parameters:
    
    appKey - app key
    
    Throws:
    
    java.lang.IllegalStateException - If the editor token is not set or initialization failed.
  - shared
```
public static LocationSharing shared()
```
    Call this method to get a valid LocationSharing instance. This object is the main API for Location Sharing
    
    Returns:
    
    current instance
  - setCurrentUser
```
public void setCurrentUser(User currentUser)
```
    Call this method to set the current logged in user
    
    Parameters:
    
    currentUser - new user
  - getCurrentUser
```
public User getCurrentUser()
```
    Call this method to get the current logged in user
    
    Returns:
    
    currentUser
  - addListener
```
public void addListener(LocationSharing.Listener listener)
```
    Set a listener if you want to know when Location Sharing starts / stops updating user locations
    
    Parameters:
    
    listener - new Location Sharing listener
  - removeListener
```
public void removeListener(LocationSharing.Listener listener)
```
    Removes a listener
    
    Parameters:
    
    listener - Location Sharing listener to remove
  - getAppKey
```
public EditorKey getAppKey()
```
    Gets the current App Key
    
    Returns:
    
    appKey - current application key
  - setAppKey
```
public void setAppKey(EditorKey appKey)
```
    Sets the current App Key
    
    Parameters:
    
    appKey - application key to use
  - getMode
```
public LocationSharing.Mode getMode()
```
    Gets the current Location Sharing mode (FOREGROUND or BACKGROUND). FOREGROUND will update user’s location more often BACKGROUND will try to save as much power as it can while still offer an accurate location
    
    Returns:
    
    current mode
  - setMode
```
public void setMode(LocationSharing.Mode mode)
```
    Location Sharing can run in two modes, FOREGROUND and BACKGROUND. FOREGROUND will update user’s location more often BACKGROUND will try to save as much power as it can while still offer an accurate location
    
    Parameters:
    
    mode - mode to run in (FOREGROUND or BACKGROUND)
  - startPostingLocationUpdates
```
public boolean startPostingLocationUpdates(@NonNull
                                           android.content.Context context)
```
    Start uploading user’s location
    
    Parameters:
    
    context - application context
    
    Returns:
    
    true if posting location updates has started
  - onRegisterJobAgainEvent
```
public void onRegisterJobAgainEvent(LocationSharing.RegisterJobAgainEvent event)
```
  - stopPostingLocationUpdates
```
public void stopPostingLocationUpdates(@NonNull
                                       android.content.Context context)
```
    Stop uploading user’s location
    
    Parameters:
    
    context - application context
  - isUploadingServiceRunning
```
public boolean isUploadingServiceRunning()
```
    Checks if the upload location service is currently running
    
    Returns:
    
    true if running
  - getStopPendingIntent
```
public android.app.PendingIntent getStopPendingIntent(@NonNull
                                                      android.content.Context context)
```
    Creates a PendingIntent to stop uploading user’s location. Useful to use in notifications for example.
    
    Parameters:
    
    context - application context
    
    Returns:
    
    pending intent
  - createUser
```
public void createUser(User user,
                       LocationSharing.Callback<User> callback)
```
    Creates a new location sharing user.
    
    Parameters:
    
    user - all user’s data. Only required field is fullName
    
    callback - returns new user
  - updateUser
```
public void updateUser(User user,
                       LocationSharing.Callback<User> callback)
```
    Updates a new location sharing user.
    
    Parameters:
    
    user - user’s data. Required fields: key, password and fullName
    
    callback - returns updated user
  - acceptInvite
```
public void acceptInvite(java.lang.String inviteKey,
                         LocationSharing.Callback<Friend> callback)
```
    Accepts an invite, creating a friendship between the current user and the invite creator.
    An user must be logged in (see setCurrentUser())
    
    Parameters:
    
    inviteKey - key of the invitation to be accepted
    
    callback - returns a Friend object with the new friend
  - createInvite
```
public void createInvite(LocationSharing.Callback<Invite> callback)
```
    Creates a new invite
    An user must be logged in (see setCurrentUser())
    
    Parameters:
    
    callback - returns new invite
  - deleteProfile
```
public void deleteProfile(@NonNull
                          android.content.Context context,
                          LocationSharing.Callback<java.lang.Void> callback)
```
    Deletes current user’s profile
    
    Parameters:
    
    callback - this method will call onSuccess if the profile was removed or onError if an error has occurred
  - removeFriend
```
public void removeFriend(java.lang.String friendId,
                         LocationSharing.Callback<java.lang.Void> callback)
```
    Removes friendship between current user and provided friend id
    An user must be logged in (see setCurrentUser())
    
    Parameters:
    
    friendId - friend id to be unfriended
    
    callback - onSuccess called if friend removed
  - uploadUserPhoto
```
public void uploadUserPhoto(@NonNull
                            android.content.Context context,
                            android.net.Uri photoUri,
                            LocationSharing.Callback<User> callback)
```
    Uploads a photo for the current user
    An user must be logged in (see setCurrentUser())
    
    Parameters:
    
    context - application context
    
    photoUri - URI of photo to upload
    
    callback - returns updated friend
  - removeUserPhoto
```
public void removeUserPhoto(LocationSharing.Callback<User> callback)
```
    Removes profile pic for the current user
    An user must be logged in (see setCurrentUser())
    
    Parameters:
    
    callback - returns updated friend
  - getFriends
```
public void getFriends(LocationSharing.Callback<java.util.List<Friend>> callback)
```
    Retrieves list of friends for the current user
    An user must be logged in (see setCurrentUser())
    
    Parameters:
    
    callback - returns list of friends
  - getInvites
```
public void getInvites(LocationSharing.Callback<java.util.List<Invite>> callback)
```
    Retrieves all invites created by the current user
    An user must be logged in (see setCurrentUser())
    
    Parameters:
    
    callback - returns list of invites
  - revokeAllInvites
```
public void revokeAllInvites(LocationSharing.Callback<java.lang.Void> callback)
```
    Revokes all invites create by the current user
    An user must be logged in (see setCurrentUser())
    
    Parameters:
    
    callback - returns onSuccess if the revoke succeeded

Class LocationSharing

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LocationSharing

Method Detail

initWithAppKey

shared

setCurrentUser

getCurrentUser

addListener

removeListener

getAppKey

setAppKey

getMode

setMode

startPostingLocationUpdates

onRegisterJobAgainEvent

stopPostingLocationUpdates

isUploadingServiceRunning

getStopPendingIntent

createUser

updateUser

acceptInvite

createInvite

deleteProfile

removeFriend

uploadUserPhoto

removeUserPhoto

getFriends

getInvites

revokeAllInvites