org.johnnei.enjin.spec.IUserAdmin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of enjin-api-spec Show documentation

The specification of the Enjin API

The newest version!

package org.johnnei.enjin.spec;

import java.util.Collection;

import org.johnnei.enjin.spec.dto.Tag;
import org.johnnei.enjin.spec.dto.User;

public interface IUserAdmin {

	/**
	 * Gets the tags for the given user on the given site
	 * @param siteId
	 *        The site for which the user tags need to be retrieved.
	 * @param user
	 *        The user for which the tags need to be retrieved.
	 * @return
	 *        The collection of tags on the user
	 */
	@EnjinMethod(
		method = "UserAdmin.getUserTags",
		allowedAuthTypes= { AuthenticationType.SESSION, AuthenticationType.API_KEY })
	Collection getUserTags(int siteId, User user);

}