org.springframework.social.weibo.api.UserOperations Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-social-weibo Show documentation

There is a newer version: 0.0.2

/*
 * Copyright 2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.social.weibo.api;

import java.util.Map;

import org.springframework.social.ApiException;

/**
 * UserOperations
 * @author cuizuoli
 */
public interface UserOperations {

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

	/**
	 * Retrieves the profile for the specified user.
	 * @param name the Weibo user name to retrieve profile data for.
	 * @return the user's profile information.
	 * @throws ApiException if there is an error while communicating with Weibo.
	 */
	Map getUserProfileByName(String name);

	/**
	 * Retrieves the profile for the specified user.
	 * @param domain the Weibo user domain to retrieve profile data for.
	 * @return the user's profile information.
	 * @throws ApiException if there is an error while communicating with Weibo.
	 */
	Map getUserProfileByDomain(String domain);

	/**
	 * Retrieves the counts for the specified user.
	 * @param userIds
	 * @return
	 */
	Map[] getUserCountsByIds(String userIds);

}