RosterManager class
This manager requires a RosterFeatureNegotiator to be registered.
- Inheritance
-
- Object
- XmppManagerBase
- RosterManager
Constructors
- RosterManager(BaseRosterStateManager _stateManager)
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Return the Id (akin to xmlns) of this manager.
finalinherited
- initialized ↔ bool
-
Flag indicating that the post registration callback has been called once.
getter/setter pairinherited
- logger → Logger
-
Return the logger for this manager.
no setterinherited
- name → String
-
The name of the manager.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addToRoster(
String jid, String title, {List< String> ? groups}) → Future<bool> -
Attempts to add
jid
with a title oftitle
and groupsgroups
to the roster. Returns true if the process was successful, false otherwise. -
getAttributes(
) → XmppManagerAttributes -
Returns the attributes that are registered with the manager.
Must only be called after register has been called on it.
inherited
-
getDiscoFeatures(
) → List< String> -
Return a list of features that should be included in a disco response.
inherited
-
getDiscoIdentities(
) → List< Identity> -
Return a list of identities that should be included in a disco response.
inherited
-
getIncomingPreStanzaHandlers(
) → List< StanzaHandler> -
Return the StanzaHandlers associated with this manager that deal with stanza handlers
that have to run before the main ones run. This is useful, for example, for OMEMO
as we have to decrypt the stanza before we do anything else. The higher the value
of the handler's priority, the earlier it is run.
inherited
-
getIncomingStanzaHandlers(
) → List< StanzaHandler> -
Return the StanzaHandlers associated with this manager that deal with stanzas we
receive. The higher the value of the
handler's priority, the earlier it is run.
override
-
getNonzaHandlers(
) → List< NonzaHandler> -
Return the NonzaHandlers associated with this manager. The higher the value of the
handler's priority, the earlier it is run.
inherited
-
getOutgoingPostStanzaHandlers(
) → List< StanzaHandler> -
Return the StanzaHandlers associated with this manager that deal with stanzas we
send. These are run after the stanza is sent. The higher the value of the
handler's priority, the earlier it is run.
inherited
-
getOutgoingPreStanzaHandlers(
) → List< StanzaHandler> -
Return the StanzaHandlers associated with this manager that deal with stanzas we
send. These are run before the stanza is sent. The higher the value of the
handler's priority, the earlier it is run.
inherited
-
isFeatureSupported(
String xmlns) → Future< bool> -
Resolves to true when the server supports the disco feature
xmlns
. Resolves to false when either the disco request fails or the server does not supportxmlns
. Note that this function requires a registered DiscoManager.inherited -
isNewStream(
) → Future< bool> -
Returns true, if the current stream negotiations resulted in a new stream. Useful
for plugins to reset their cache in case of a new stream.
The value only makes sense after receiving a StreamNegotiationsDoneEvent.
inherited
-
isSupported(
) → Future< bool> -
Returns true if the XEP is supported on the server. If not, returns false
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onData(
) → Future< void> -
Whenever the socket receives data, this method is called, if it is non-null.
inherited
-
onXmppEvent(
XmppEvent event) → Future< void> -
Called when XmppConnection triggers an event
inherited
-
postRegisterCallback(
) → Future< void> -
Called after the registration of all managers against the XmppConnection is done.
This method is only called once during the entire lifetime of it.
inherited
-
register(
XmppManagerAttributes attributes) → void -
Registers the callbacks from XmppConnection with the manager
override
-
removeFromRoster(
String jid) → Future< RosterRemovalResult> -
Attempts to remove
jid
from the roster. Returns true if the process was successful, false otherwise. -
reply(
StanzaHandlerData data, String type, List< XMLNode> children) → Future<void> -
Sends a reply of the stanza in
data
withtype
. Replaces the original stanza's children withchildren
.inherited -
requestRoster(
{bool useRosterVersion = true}) → Future< Result< RosterRequestResult, RosterError> > -
Requests the roster following RFC 6121. If
useRosterVersion
is set to false, then roster versioning will not be used, even if the server supports it and we have a last known roster version. -
requestRosterPushes(
) → Future< Result< RosterRequestResult?, RosterError> > - Requests a series of roster pushes according to RFC6121. Requires that the server advertises urn:xmpp:features:rosterver in the stream features.
-
rosterVersioningAvailable(
) → bool -
runNonzaHandlers(
XMLNode nonza) → Future< bool> -
Runs all NonzaHandlers of this Manager which match the nonza. Resolves to true if
the nonza has been handled by one of the handlers. Resolves to false otherwise.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited