Android Open Source - uppidy-android-sdk User Operations

From Project

Back to project page uppidy-android-sdk.

License

The source code is released under:

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCT...

If you think the Android project uppidy-android-sdk listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.

Java Source Code

package com.uppidy.android.sdk.api;
//  w  w w.j  a va 2 s  .c  o m
import java.util.List;

import org.springframework.social.ApiException;
import org.springframework.social.MissingAuthorizationException;

/**
 * Interface defining operations that can be performed on a Uppidy user
 * profiles.
 * 
 * @author arudnev@uppidy.com
 */
public interface UserOperations {

  /**
   * Retrieves the profile for the authenticated user.
   * 
   * @return the user's profile information.
   * @throws ApiException
   *             if there is an error while communicating with Uppidy.
   * @throws MissingAuthorizationException
   *             if UppidyTemplate was not created with an access token.
   */
  ApiProfile getUserProfile();

  /**
   * Retrieves the profile for the specified user.
   * 
   * @param userId
   *            the Uppidy user ID to retrieve profile data for.
   * @return the user's profile information.
   * @throws ApiException
   *             if there is an error while communicating with Uppidy.
   */
  ApiProfile getUserProfile(String userId);

  /**
   * Retrieves a list of permissions that the application has been granted for
   * the authenticated user.
   * 
   * @return the permissions granted for the user.
   * @throws ApiException
   *             if there is an error while communicating with Uppidy.
   * @throws MissingAuthorizationException
   *             if UppidyTemplate was not created with an access token.
   */
  List<String> getUserPermissions();

  /**
   * Searches for users.
   * 
   * @param query
   *            the search query (e.g., "John Smith")
   * @return a list of {@link ApiContactInfo}s, each representing a user who
   *         matched the given query.
   * @throws ApiException
   *             if there is an error while communicating with Uppidy.
   * @throws MissingAuthorizationException
   *             if UppidyTemplate was not created with an access token.
   */
  List<ApiContactInfo> search(String query);
}

Java Source Code List