UserAvatarManager class
NOTE: This class requires a PubSubManager
- Inheritance
-
- Object
- XmppManagerBase
- UserAvatarManager
Constructors
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
-
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.
override
-
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.
inherited
-
getLatestMetadata(
JID jid) → Future< Result< AvatarError, List< >UserAvatarMetadata> > - Attempts to fetch the latest item from the User Avatar metadata node. Returns the list of metadata contained within it. The list may be empty.
-
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
-
getUserAvatarData(
JID jid, String id) → Future< Result< AvatarError, UserAvatarData> > -
Requests the avatar from
jid
. Returns the avatar data if the request was successful. Null otherwise -
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
override
-
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
-
publishUserAvatar(
String base64, String hash, bool public) → Future< Result< AvatarError, bool> > -
Publish the avatar data,
base64
, on the pubsub node usinghash
as the item id.hash
must be the SHA-1 hash of the image data, whilebase64
must be the base64-encoded version of the image data. -
publishUserAvatarMetadata(
UserAvatarMetadata metadata, bool public) → Future< Result< AvatarError, bool> > -
Publish avatar metadata
metadata
to the User Avatar's metadata node. Ifpublic
is true, then the node will be set to an 'open' access model. Ifpublic
is false, then the node will be set to an 'roster' access model. -
register(
XmppManagerAttributes attributes) → void -
Registers the callbacks from XmppConnection with the manager
inherited
-
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 -
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
-
subscribe(
JID jid) → Future< Result< AvatarError, bool> > -
Subscribe the data and metadata node of
jid
. -
toString(
) → String -
A string representation of this object.
inherited
-
unsubscribe(
JID jid) → Future< Result< AvatarError, bool> > -
Unsubscribe the data and metadata node of
jid
.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited