Index (Silverpeas Chat Service 6.4 6.4 API)

A C D E F G H I L O P R S U V
All Classes All Packages

A

at(String, String...) - Method in class org.silverpeas.core.chat.servers.HttpRequester: Sets the specified URL of the resource to request.
autoJoinOnInvite() - Method in class org.silverpeas.core.chat.ChatSettings: If true, the user will automatically join a chatroom on invite without any confirm.
autoRegisterMucNickname() - Method in class org.silverpeas.core.chat.ChatSettings: If truthy, Converse will automatically register a user’s nickname upon entering a groupchat.

C

ChatGroupUserLinkEventListener - Class in org.silverpeas.core.chat.listeners: Listens for adding or removing of users in user groups.
ChatGroupUserLinkEventListener() - Constructor for class org.silverpeas.core.chat.listeners.ChatGroupUserLinkEventListener
ChatInitialization - Class in org.silverpeas.core.chat: Initializes the resources required by the Chat to work correctly.
ChatInitialization() - Constructor for class org.silverpeas.core.chat.ChatInitialization
ChatLocalizationProvider - Class in org.silverpeas.core.chat: A provider of a localization bundle for the chat service.
ChatServer - Interface in org.silverpeas.core.chat.servers: This interface represents a Chat server.
ChatServerException - Exception in org.silverpeas.core.chat: Thrown when an error need external intervention to be fixed
ChatServerException(String) - Constructor for exception org.silverpeas.core.chat.ChatServerException
ChatServerException(String, Throwable) - Constructor for exception org.silverpeas.core.chat.ChatServerException
ChatServerException(Throwable) - Constructor for exception org.silverpeas.core.chat.ChatServerException
ChatSettings - Class in org.silverpeas.core.chat: Setting properties of the chat service.
ChatSettings() - Constructor for class org.silverpeas.core.chat.ChatSettings: Constructs a new object wrapping all the settings on the Silverpeas chat service.
ChatSettings.ChatACL - Class in org.silverpeas.core.chat: ACL on the behaviour of the chat client.
ChatSettings.ChatACL.GroupChat - Class in org.silverpeas.core.chat: ACL on the behaviour of the group chats
ChatSettings.JidFormatPolicy - Enum in org.silverpeas.core.chat
ChatUser - Class in org.silverpeas.core.chat: A Silverpeas user with an account in a Chat service.
ChatUserEventListener - Class in org.silverpeas.core.chat.listeners: Listen user modifications to clone them in Chat server
ChatUserEventListener() - Constructor for class org.silverpeas.core.chat.listeners.ChatUserEventListener
ChatUsersRegistration - Class in org.silverpeas.core.chat: Registration of a user in the remote Chat server.
ChatUsersRegistration() - Constructor for class org.silverpeas.core.chat.ChatUsersRegistration
clearCacheOnLogout() - Method in class org.silverpeas.core.chat.ChatSettings: Allows clearing the cache linked to ConverseJS on user logout.
clearMessagesOnReconnection() - Method in class org.silverpeas.core.chat.ChatSettings: Indicates if messages MUST be cleared after a user reconnection.
close() - Method in class org.silverpeas.core.chat.servers.HttpRequester: Closes this HttpRequester.
createRelationShip(User, User) - Method in interface org.silverpeas.core.chat.servers.ChatServer: Creates a relationship between the two specified user in the chat server.
createRelationShip(User, User) - Method in class org.silverpeas.core.chat.servers.EJabberdServer
createRelationShip(User, User) - Method in class org.silverpeas.core.chat.servers.OpenfireServer
createUser(User) - Method in interface org.silverpeas.core.chat.servers.ChatServer: Creates an account in the chat server for the specified user.
createUser(User) - Method in class org.silverpeas.core.chat.servers.EJabberdServer
createUser(User) - Method in class org.silverpeas.core.chat.servers.OpenfireServer

D

DefaultChatServer - Annotation Type in org.silverpeas.core.chat.servers: A qualifier to identify an implementation of the ChatServer interface as the default chat server to use if there is more than one implementation available.
DefaultChatServer.Literal - Class in org.silverpeas.core.chat.servers: Supports inline instantiation of the DefaultChatServer qualifier.
delete() - Method in class org.silverpeas.core.chat.servers.HttpRequester: Deletes the resource referred by the set URL.
deleteRelationShip(User, User) - Method in interface org.silverpeas.core.chat.servers.ChatServer: Deletes the relationship existing between the two specified user in the chat server.
deleteRelationShip(User, User) - Method in class org.silverpeas.core.chat.servers.EJabberdServer
deleteRelationShip(User, User) - Method in class org.silverpeas.core.chat.servers.OpenfireServer
deleteUser(User) - Method in interface org.silverpeas.core.chat.servers.ChatServer: Deletes in the chat server the account of the specified user.
deleteUser(User) - Method in class org.silverpeas.core.chat.servers.EJabberdServer
deleteUser(User) - Method in class org.silverpeas.core.chat.servers.OpenfireServer

E

EJabberdServer - Class in org.silverpeas.core.chat.servers: Adapter to a remote ejabberd service.
EJabberdServer() - Constructor for class org.silverpeas.core.chat.servers.EJabberdServer: Constructs a new instance.
equals(Object) - Method in class org.silverpeas.core.chat.ChatUser

F

fromUser(User) - Static method in class org.silverpeas.core.chat.ChatUser: Creates a new ChatUser from the specified Silverpeas user.

G

get() - Static method in class org.silverpeas.core.chat.ChatSettings: Gets an instance of the ChatSettings class.
get() - Static method in interface org.silverpeas.core.chat.servers.ChatServer
getAccessLevel() - Method in class org.silverpeas.core.chat.ChatUser
getACL() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the ACL on the chat client.
getAclOnGroupChat() - Method in class org.silverpeas.core.chat.ChatSettings.ChatACL
getAllowedUserGroups() - Method in class org.silverpeas.core.chat.ChatSettings: Gets all the user groups in Silverpeas that are allowed to use the chat service, id est the groups for which the chat is enabled.
getAvatar() - Method in class org.silverpeas.core.chat.ChatUser
getBOSHServiceUrl() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the fully qualified URL of the BOSH service of the XMPP server which wich Silverpeas can use to establish XMPP communications through the web.
getById(String) - Static method in class org.silverpeas.core.chat.ChatUser: Gets a chat user from the specified Silverpeas unique identifier.
getChatDomain() - Method in class org.silverpeas.core.chat.ChatUser: Gets the chat domain to which this user belongs.
getChatId() - Method in class org.silverpeas.core.chat.ChatUser: Gets the unique identifier of this user in the chat service.
getChatLogin() - Method in class org.silverpeas.core.chat.ChatUser: Gets the chat service login of this user.
getChatPassword() - Method in class org.silverpeas.core.chat.ChatUser: Gets the chat service password of this user.
getChatServerUrl() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the URL at which the chat server is listening.
getChatSettings() - Static method in interface org.silverpeas.core.chat.servers.ChatServer: Gets the settings on the chat service.
getCreationDate() - Method in class org.silverpeas.core.chat.ChatUser
getCurrentRequester() - Static method in class org.silverpeas.core.chat.ChatUser: Gets the user behind the current request to Silverpeas and that have an account in the chat service.
getDefaultXmppDomain() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the XMPP domain to use for any Silverpeas domains that have no mapping rule to a XMPP domain.
getDisplayedName() - Method in class org.silverpeas.core.chat.ChatUser
getDomainId() - Method in class org.silverpeas.core.chat.ChatUser
getDurationOfCurrentSession() - Method in class org.silverpeas.core.chat.ChatUser
getEmailAddress() - Method in class org.silverpeas.core.chat.ChatUser
getExplicitMappedXmppDomain(String) - Method in class org.silverpeas.core.chat.ChatSettings: Gets the XMPP domain mapped with the specified Silverpeas domain.
getFileTransferServiceUrl() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the base URL of the HTTP file transfer service of the XMPP server.
getFirstName() - Method in class org.silverpeas.core.chat.ChatUser
getGroupsAllowedToCreate() - Method in class org.silverpeas.core.chat.ChatSettings.ChatACL.GroupChat: Gets the list of identifiers of the groups of users in Silverpeas that are allowed to create a group chat and then to invite others users in that group chat.
getICEServer() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the fully qualified hostname or the IP address of the ICE server listening for audio/video communications.
getId() - Method in class org.silverpeas.core.chat.ChatUser
getJidFormatPolicy() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the policy on how the JID should be formatted.
getLastName() - Method in class org.silverpeas.core.chat.ChatUser
getLocalizationBundle() - Static method in class org.silverpeas.core.chat.ChatLocalizationProvider
getLocalizationBundle(String) - Static method in class org.silverpeas.core.chat.ChatLocalizationProvider
getLogin() - Method in class org.silverpeas.core.chat.ChatUser
getMappedXmppDomain(String) - Method in class org.silverpeas.core.chat.ChatSettings: Gets the XMPP domain in the chat server that is mapped to the specified Silverpeas domain.
getMaxCachedMsgThresholdPerRoom() - Method in class org.silverpeas.core.chat.ChatSettings: Gets for a room the threshold of cached messages over that the messages are clean from the web browser storage.
getRestApiAuthToken() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the authorization token to use when communicating the REST API of the XMPP server.
getRestApiUrl() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the fully qualified URL of the REST API of the XMPP server with which Silverpeas can use to create and to remove XMPP users accounts.
getSaveDate() - Method in class org.silverpeas.core.chat.ChatUser
getSilverpeasChatClientId() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the identifier of the chat client from point of view of Silverpeas server.
getSmallAvatar() - Method in class org.silverpeas.core.chat.ChatUser
getState() - Method in class org.silverpeas.core.chat.ChatUser
getStateSaveDate() - Method in class org.silverpeas.core.chat.ChatUser
getStatus() - Method in class org.silverpeas.core.chat.ChatUser
getUserPreferences() - Method in class org.silverpeas.core.chat.ChatUser
getVersion() - Method in class org.silverpeas.core.chat.ChatUser
getVisioDomainServer() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the internal visio starter page that permits to perform the visio into an iframe.
getVisioJwt() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the JWT token in order to get rights to use the visio services.
getVisioUrl() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the URL that permits to perform the visio into an iframe.
getWebsocketServiceUrl() - Method in class org.silverpeas.core.chat.ChatSettings: Gets the fully qualified URL of the websocket service of the XMPP server which wich Silverpeas can use to establish XMPP communications through the web.

H

hashCode() - Method in class org.silverpeas.core.chat.ChatUser
head() - Method in class org.silverpeas.core.chat.servers.HttpRequester: Sends a HEAD HTTP request to the set URL in order to obtain some information about the remote Web resource.
header(String, String) - Method in class org.silverpeas.core.chat.servers.HttpRequester: Sets an HTTP header.
HttpRequester - Class in org.silverpeas.core.chat.servers: An HTTP requester.
HttpRequester(String) - Constructor for class org.silverpeas.core.chat.servers.HttpRequester: Constructs a new HttpRequester with the specified authentication token that will used to identify and to authorize the requester to perform some tasks in the remote resource.

I

init() - Method in class org.silverpeas.core.chat.ChatInitialization
INSTANCE - Static variable in class org.silverpeas.core.chat.servers.DefaultChatServer.Literal
isAccessAdmin() - Method in class org.silverpeas.core.chat.ChatUser
isAccessDomainManager() - Method in class org.silverpeas.core.chat.ChatUser
isAccessGuest() - Method in class org.silverpeas.core.chat.ChatUser
isAccessPdcManager() - Method in class org.silverpeas.core.chat.ChatUser
isAccessUnknown() - Method in class org.silverpeas.core.chat.ChatUser
isAccessUser() - Method in class org.silverpeas.core.chat.ChatUser
isActivatedState() - Method in class org.silverpeas.core.chat.ChatUser
isAllowed(User) - Method in interface org.silverpeas.core.chat.servers.ChatServer: Is the specified user is allowed to access the chat service?
isAlreadyRegistered(User) - Method in class org.silverpeas.core.chat.ChatUsersRegistration: Is the specified user already registered into the remote chat server?
isAnonymous() - Method in class org.silverpeas.core.chat.ChatUser
isAtLeastInOneGroup(List<String>) - Method in class org.silverpeas.core.chat.ChatUser: Is the user at least in one of the following groups of users in Silverpeas?
isBlanked() - Method in class org.silverpeas.core.chat.ChatUser
isBlockedState() - Method in class org.silverpeas.core.chat.ChatUser
isChatEnabled() - Method in class org.silverpeas.core.chat.ChatSettings: Is the chat service enabled in Silverpeas?
isChatEnabled() - Method in class org.silverpeas.core.chat.ChatUser: Is the chat service is enabled for this user?
isChatServerSafeUrl() - Method in class org.silverpeas.core.chat.ChatSettings: Is the URL given by ChatSettings.getChatServerUrl() a safe one.
isChatServiceEnabled() - Method in class org.silverpeas.core.chat.ChatUsersRegistration: Is the chat service enabled in Silverpeas?
isConnected() - Method in class org.silverpeas.core.chat.ChatUser
isDeactivatedState() - Method in class org.silverpeas.core.chat.ChatUser
isDeletedState() - Method in class org.silverpeas.core.chat.ChatUser
isDomainAdminRestricted() - Method in class org.silverpeas.core.chat.ChatUser
isDomainRestricted() - Method in class org.silverpeas.core.chat.ChatUser
isEnabled() - Method in class org.silverpeas.core.chat.listeners.ChatUserEventListener
isEnabled() - Method in class org.silverpeas.core.chat.listeners.RelationShipListener
isEnabled() - Static method in interface org.silverpeas.core.chat.servers.ChatServer: Is a chat server enabled?
isExpiredState() - Method in class org.silverpeas.core.chat.ChatUser
isFullyDefined() - Method in class org.silverpeas.core.chat.ChatUser
isPlayingAdminRole(String) - Method in class org.silverpeas.core.chat.ChatUser
isReactionToEnabled() - Method in class org.silverpeas.core.chat.ChatSettings: Indicates if the 'reaction to' message is enabled.
isRegistered() - Method in class org.silverpeas.core.chat.ChatUser: Has the user already an account in the chat server?
isRemovedState() - Method in class org.silverpeas.core.chat.ChatUser
isReplyToEnabled() - Method in class org.silverpeas.core.chat.ChatSettings: Indicates if the 'reply to' message is enabled.
isScreencastEnabled() - Method in class org.silverpeas.core.chat.ChatSettings: Indicates if the screencast is enabled.
isSystem() - Method in class org.silverpeas.core.chat.ChatUser
isUserDomainSupported(String) - Method in interface org.silverpeas.core.chat.servers.ChatServer: Is the specified Silverpeas domain is supported by the chat server?
isUserExisting(User) - Method in interface org.silverpeas.core.chat.servers.ChatServer: Is the specified user has already an account in the chat server?
isUserExisting(User) - Method in class org.silverpeas.core.chat.servers.EJabberdServer
isUserExisting(User) - Method in class org.silverpeas.core.chat.servers.OpenfireServer
isValidState() - Method in class org.silverpeas.core.chat.ChatUser
isVisioEnabled() - Method in class org.silverpeas.core.chat.ChatSettings: Indicates if the visio conference is enabled.

L

Literal() - Constructor for class org.silverpeas.core.chat.servers.DefaultChatServer.Literal

O

onCreation(GroupUserLinkEvent) - Method in class org.silverpeas.core.chat.listeners.ChatGroupUserLinkEventListener
onCreation(UserEvent) - Method in class org.silverpeas.core.chat.listeners.ChatUserEventListener: A new user has been created in Silverpeas, then creates his account in the remote chat service.
onCreation(RelationShipEvent) - Method in class org.silverpeas.core.chat.listeners.RelationShipListener
onDeletion(GroupUserLinkEvent) - Method in class org.silverpeas.core.chat.listeners.ChatGroupUserLinkEventListener
onDeletion(UserEvent) - Method in class org.silverpeas.core.chat.listeners.ChatUserEventListener: An existing user in Silverpeas has been deleted, then the account of the deleted user in the remote chat service is also deleted.
onDeletion(RelationShipEvent) - Method in class org.silverpeas.core.chat.listeners.RelationShipListener
OpenfireServer - Class in org.silverpeas.core.chat.servers: Openfire server management service
OpenfireServer() - Constructor for class org.silverpeas.core.chat.servers.OpenfireServer
org.silverpeas.core.chat - package org.silverpeas.core.chat: Provides the Silverpeas Chat Service.
org.silverpeas.core.chat.listeners - package org.silverpeas.core.chat.listeners
org.silverpeas.core.chat.servers - package org.silverpeas.core.chat.servers: Provides the adapters to different remote chat services.

P

post(UnaryOperator<JSONCodec.JSONObject>) - Method in class org.silverpeas.core.chat.servers.HttpRequester: Posts to resource referred by the set URL the data that are generated by the specified builder.

R

registerUser(User) - Method in class org.silverpeas.core.chat.ChatUsersRegistration: Registers the specified user into the remote chat server.
RELATIONSHIP_ALREADY_EXIST - Static variable in exception org.silverpeas.core.chat.ChatServerException: Relationship already exist
RELATIONSHIP_CREATION_FAIL - Static variable in exception org.silverpeas.core.chat.ChatServerException: Error while creating relationship
RELATIONSHIP_DELETION_FAIL - Static variable in exception org.silverpeas.core.chat.ChatServerException: Error while deleting relationship
RelationShipListener - Class in org.silverpeas.core.chat.listeners: Listen relationship modifications to clone them in the Chat server
RelationShipListener() - Constructor for class org.silverpeas.core.chat.listeners.RelationShipListener
REMOVED - org.silverpeas.core.chat.ChatSettings.JidFormatPolicy

S

SPECIFIC_CODE - org.silverpeas.core.chat.ChatSettings.JidFormatPolicy
STATUS_CONFLICT - Static variable in class org.silverpeas.core.chat.servers.HttpRequester: The status code for a request resulting to a conflict in the server.
STATUS_CREATED - Static variable in class org.silverpeas.core.chat.servers.HttpRequester: The status code for a request resulting to the successful creation of a resource in the server.
STATUS_FORBIDDEN - Static variable in class org.silverpeas.core.chat.servers.HttpRequester: The status code for a forbidden request.
STATUS_OK - Static variable in class org.silverpeas.core.chat.servers.HttpRequester: The status code for a successful request.
STATUS_UNAUTHORIZED - Static variable in class org.silverpeas.core.chat.servers.HttpRequester: The status code for an unauthorized request.

U

unregisterUser(User) - Method in class org.silverpeas.core.chat.ChatUsersRegistration: Unregisters the specified user from the remote chat server.
USER_ACCESS_FAIL - Static variable in exception org.silverpeas.core.chat.ChatServerException: Error while accessing the profile of the user.
USER_CREATION_FAIL - Static variable in exception org.silverpeas.core.chat.ChatServerException: Error while creating user
USER_DELETION_FAIL - Static variable in exception org.silverpeas.core.chat.ChatServerException: Error while deleting user

V

valueOf(String) - Static method in enum org.silverpeas.core.chat.ChatSettings.JidFormatPolicy: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.silverpeas.core.chat.ChatSettings.JidFormatPolicy: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I L O P R S U V
All Classes All Packages