public interface

OmletIdentityApi

mobisocial.omlib.api.OmletIdentityApi

Class Overview

APIs for accessing user accounts and identities.

Summary

Public Methods
abstract void addContact(String account)
Adds a contact to the user's friend list, without mutual friending.
abstract void addContactWithPin(String account, String pin)
Mutually add a contact using a PIN code shared by that account.
abstract Uri getInvitationLink()
Generate a link to share out-of-band (SMS, email, chat, Twitter, Facebook) that can be used to invite friends to download the app, and also to add this user as a friend in the app.
abstract AccountProfile lookupProfile(String account)
abstract AccountProfile lookupProfile(RawIdentity rawIdentity)
abstract void setUserNickname(String nickname)
Sets the display name for the connected user's account.
abstract void setUserProfileImage(InputStream image)
Sets the user's profile picture to the given image.
abstract void setUserProfileVideo(InputStream video, InputStream thumbnail)
abstract void uploadAddressBook(CancellationSignal cancellation)

Uploads hashed identities from the user's local address book to find friends who also have user accounts.

Public Methods

public abstract void addContact (String account)

Adds a contact to the user's friend list, without mutual friending.

Throws
NetworkException

public abstract void addContactWithPin (String account, String pin)

Mutually add a contact using a PIN code shared by that account.

Throws
NetworkException

public abstract Uri getInvitationLink ()

Generate a link to share out-of-band (SMS, email, chat, Twitter, Facebook) that can be used to invite friends to download the app, and also to add this user as a friend in the app.

Throws
NetworkException

public abstract AccountProfile lookupProfile (String account)

Throws
NetworkException

public abstract AccountProfile lookupProfile (RawIdentity rawIdentity)

Throws
NetworkException

public abstract void setUserNickname (String nickname)

Sets the display name for the connected user's account. Uses jobs so it is guaranteed to execute.

public abstract void setUserProfileImage (InputStream image)

Sets the user's profile picture to the given image. Uses jobs so it is guaranteed to execute.

Throws
IOException

public abstract void setUserProfileVideo (InputStream video, InputStream thumbnail)

Throws
IOException

public abstract void uploadAddressBook (CancellationSignal cancellation)

Uploads hashed identities from the user's local address book to find friends who also have user accounts.

This method can take a long time, and so should be run in the background, for example using an android.os.AsyncTask.

Parameters
cancellation Cancellation signal that halts the upload. May be null.