AvatarManagerProxy (Jive Forums API (5.5.8) Developer Javadocs)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Jive Forums API (5.5.8) Developer Javadocs

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.jivesoftware.forum.proxy
Class AvatarManagerProxy

java.lang.Object
  com.jivesoftware.forum.proxy.AvatarManagerProxy

All Implemented Interfaces:: AvatarManager

public class AvatarManagerProxy
extends java.lang.Object
implements AvatarManager
extends java.lang.Object
implements AvatarManager

Constructor Summary
`AvatarManagerProxy(AvatarManager avatarManager, AuthToken authToken, Permissions permissions)`

Method Summary
`Avatar`	`createAvatar(User owner, java.lang.String name, java.lang.String contentType, java.io.InputStream in)` Creates a new avatar for a user allowing the user to specify an inputstream for the image.
`void`	`deleteAvatar(Avatar avatar)` Deletes an avatar from the system.
`Avatar`	`getActiveAvatar(User user)` Returns an avatar for a user, else null if no avatar exists for this user
`Avatar`	`getAvatar(long id)` Used to acquire an avatar by its id
`int`	`getAvatarCount(User user)` Used to acquire a count of all the avatars for a specific user
`java.util.Iterator`	`getAvatars(User user)` Returns a collection of avatars for a user
`java.util.Iterator`	`getGlobalAvatars()` Returns a collection of all of the global avatars
`int`	`getMaxAllowableHeight()` Returns the maximum allowable height for an avatar image
`int`	`getMaxAllowableWidth()` Returns the maximum allowable width for an avatar image
`int`	`getMaxUserAvatars()` Returns the maximum amount of avatars a user is allowed to have, -1 for limitless
`int`	`getModerationAvatarCount()` Used to acquire a count of all the avatars that require moderation.
`java.util.Iterator`	`getModerationAvatars()` Returns a collection of all of the avatars that require moderation.
`boolean`	`isAllowImageResize()` Returns true if the system should attempt to resize images
`boolean`	`isAvatarsEnabled()` Returns true if the avatars feature is enabled, else false
`boolean`	`isModerateUserAvatars()` Returns whether or not user avatars will be moderated.
`boolean`	`isUserAvatarsEnabled()` Returns true if users can create their own avatars, false otherwise.
`void`	`setActiveAvatar(User user, Avatar avatar)` Used to make a user use a global avatar, to set no active avatar pass null for the avatar value.
`void`	`setAllowImageResize(boolean isAllowImageResize)` Used to set whether the system should attempt to resize images
`void`	`setAvatarsEnabled(boolean enabled)` Used to disable or enable the avatars feature
`void`	`setMaxAllowableHeight(int height)` Sets the maximum allowable height for an avatar image
`void`	`setMaxAllowableWidth(int width)` Sets the maximum allowable width for an avatar image
`void`	`setMaxUserAvatars(int max)` Sets the maximum number of avatars a user can have
`void`	`setModerateUserAvatars(boolean moderateUserAvatars)` Sets whether or not user avatars will be moderated.
`void`	`setUserAvatarsEnabled(boolean enableCustomAvatars)` Sets whether or not users can create their own custom avatars.

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

Constructor Detail

AvatarManagerProxy

public AvatarManagerProxy(AvatarManager avatarManager,
                          AuthToken authToken,
                          Permissions permissions)

Method Detail