Index (XWiki Platform - Mentions

A C D E F G H I L M N O S T U V
All Classes All Packages

A

addMention(String, MentionNotificationParameter) - Method in class org.xwiki.mentions.notifications.MentionNotificationParameters: Add a mention to the map of mentions.
addNewMention(String, MentionNotificationParameter) - Method in class org.xwiki.mentions.notifications.MentionNotificationParameters: Add a mention to the map of new mentions.
ANNOTATION - org.xwiki.mentions.MentionLocation: In an annotation.
AWM_FIELD - org.xwiki.mentions.MentionLocation: Deprecated.

C

COMMENT - org.xwiki.mentions.MentionLocation: In a comment.

D

DisplayStyle - Enum in org.xwiki.mentions: List of the different display style of the user mentions.
DOCUMENT - org.xwiki.mentions.MentionLocation: Body of a document.

E

equals(Object) - Method in class org.xwiki.mentions.events.MentionEvent
equals(Object) - Method in class org.xwiki.mentions.events.MentionEventParams
equals(Object) - Method in class org.xwiki.mentions.notifications.MentionNotificationParameter
equals(Object) - Method in class org.xwiki.mentions.notifications.MentionNotificationParameters
EVENT_TYPE - Static variable in class org.xwiki.mentions.events.MentionEvent: Name of the mention event.

F

FIRST_NAME - org.xwiki.mentions.DisplayStyle: Displays only the first name of the mentioned user.
format(String, DisplayStyle, String) - Method in class org.xwiki.mentions.script.MentionsScriptService: Format an actor mention according to its type.
formatMention(String, DisplayStyle) - Method in interface org.xwiki.mentions.MentionsFormatter: Format a actor mention.
FULL_NAME - org.xwiki.mentions.DisplayStyle: Displays the first and last name of the mentioned user.

G

getAnchor() - Method in class org.xwiki.mentions.events.MentionEventParams
getAnchorId() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameter
getAuthorReference() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameters
getDisplayStyle() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameter
getDocumentReference() - Method in class org.xwiki.mentions.events.MentionEventParams
getEntityReference() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameters
getLocation() - Method in class org.xwiki.mentions.events.MentionEventParams
getLocation() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameters
getMentions() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameters: Returns an unmodifiable map of all the mentions, including the new ones.
getMentionsColor() - Method in interface org.xwiki.mentions.MentionsConfiguration
getMentionsColor() - Method in class org.xwiki.mentions.script.MentionsScriptService
getNewMentions() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameters: Returns an unmodifable map of the new mentions.
getOrDefault(String) - Static method in enum org.xwiki.mentions.DisplayStyle
getParams() - Method in class org.xwiki.mentions.events.MentionEvent
getQueueSize() - Method in class org.xwiki.mentions.script.MentionsScriptService
getQuote() - Method in class org.xwiki.mentions.events.MentionEventParams
getReference() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameter
getSelfMentionsColor() - Method in interface org.xwiki.mentions.MentionsConfiguration
getSelfMentionsColor() - Method in class org.xwiki.mentions.script.MentionsScriptService
getTarget() - Method in class org.xwiki.mentions.events.MentionEvent
getUserReference() - Method in class org.xwiki.mentions.events.MentionEventParams
getVersion() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameters

H

hashCode() - Method in class org.xwiki.mentions.events.MentionEvent
hashCode() - Method in class org.xwiki.mentions.events.MentionEventParams
hashCode() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameter
hashCode() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameters

I

isQuoteActivated() - Method in interface org.xwiki.mentions.MentionsConfiguration
isQuoteActivated() - Method in class org.xwiki.mentions.script.MentionsScriptService

L

LOGIN - org.xwiki.mentions.DisplayStyle: Displays the login of the mentioned user.

M

matches(Object) - Method in class org.xwiki.mentions.events.MentionEvent
matches(Object) - Method in class org.xwiki.mentions.events.NewMentionsEvent
MENTION_TASK_ID - Static variable in interface org.xwiki.mentions.MentionsConfiguration: The identifier of the mention tasks.
MentionEvent - Class in org.xwiki.mentions.events: The mention event.
MentionEvent(Set<String>, MentionEventParams) - Constructor for class org.xwiki.mentions.events.MentionEvent: Default constructor.
MentionEventParams - Class in org.xwiki.mentions.events: The parameters of the mention event.
MentionEventParams() - Constructor for class org.xwiki.mentions.events.MentionEventParams
MentionException - Exception in org.xwiki.mentions: Generic exception for the Mention module.
MentionException(String) - Constructor for exception org.xwiki.mentions.MentionException: Construct a new MentionsException with the specified detail message.
MentionException(String, Throwable) - Constructor for exception org.xwiki.mentions.MentionException: Constructs a new MentionsException with the specified detail message and cause.
MentionLocation - Enum in org.xwiki.mentions: List the location where mentions can occur.
MentionNotificationParameter - Class in org.xwiki.mentions.notifications: Holds a mention notification parameter, composed of the reference of the mentioned actor, the unique anchor identifier of the mention in a page, and the display style of the mention.
MentionNotificationParameter(String, String, DisplayStyle) - Constructor for class org.xwiki.mentions.notifications.MentionNotificationParameter
MentionNotificationParameters - Class in org.xwiki.mentions.notifications: Contains the mentions for a change (creation or modification) on a given entity.
MentionNotificationParameters(String, EntityReference, MentionLocation, String) - Constructor for class org.xwiki.mentions.notifications.MentionNotificationParameters
MentionsConfiguration - Interface in org.xwiki.mentions: Gives access to the configuration settings of the mentions.
MentionsFormatter - Interface in org.xwiki.mentions: Provides services to format the user mentions.
MentionsScriptService - Class in org.xwiki.mentions.script: Script service for the Mentions application.
MentionsScriptService() - Constructor for class org.xwiki.mentions.script.MentionsScriptService

N

NewMentionsEvent - Class in org.xwiki.mentions.events: An event sent at the end of the analysis of a document change (i.e., a created or updated document).
NewMentionsEvent() - Constructor for class org.xwiki.mentions.events.NewMentionsEvent

O

org.xwiki.mentions - package org.xwiki.mentions
org.xwiki.mentions.events - package org.xwiki.mentions.events
org.xwiki.mentions.notifications - package org.xwiki.mentions.notifications
org.xwiki.mentions.script - package org.xwiki.mentions.script

S

setAnchor(String) - Method in class org.xwiki.mentions.events.MentionEventParams
setDocumentReference(String) - Method in class org.xwiki.mentions.events.MentionEventParams
setLocation(MentionLocation) - Method in class org.xwiki.mentions.events.MentionEventParams
setQuote(String) - Method in class org.xwiki.mentions.events.MentionEventParams
setUserReference(String) - Method in class org.xwiki.mentions.events.MentionEventParams

T

TEXT_FIELD - org.xwiki.mentions.MentionLocation: In a large text field.
toString() - Method in class org.xwiki.mentions.events.MentionEvent
toString() - Method in class org.xwiki.mentions.events.MentionEventParams
toString() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameter
toString() - Method in class org.xwiki.mentions.notifications.MentionNotificationParameters

U

UNDEFINED - org.xwiki.mentions.MentionLocation: When the location of the mention is unknown.
USER_MENTION_TYPE - Static variable in interface org.xwiki.mentions.MentionsConfiguration: The type of the mentions to local users.

V

valueOf(String) - Static method in enum org.xwiki.mentions.DisplayStyle: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.xwiki.mentions.MentionLocation: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.xwiki.mentions.DisplayStyle: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.xwiki.mentions.MentionLocation: 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 M N O S T U V
All Classes All Packages