haXe
HXMPP API
Back
|
Index
class
jabber.client.Roster
Client roster (serverside saved contact list)
var
available(default,null) :
Bool
var
groups(getGroups,null) :
Array
<
String
>
var
items(default,null) :
Array
<
xmpp.roster.Item
>
var
stream(default,null) :
Stream
var
subscriptionMode :
RosterSubscriptionMode
function
new(stream :
Stream
, ?subscriptionMode :
RosterSubscriptionMode
) :
Void
function
addItem(jid :
String
, ?groups :
Iterable
<
String
>) :
Bool
Add entry to your roster
function
cancelSubscription(jid :
String
) :
Bool
Cancel the subscription from entity. You will no longer recieve presence updates.
function
confirmSubscription(jid :
String
, ?allow :
Bool
, ?subscribe :
Bool
) :
Void
Allow the requesting entity to recieve presence updates from you.
function
getItem(jid :
String
) :
xmpp.roster.Item
function
hasItem(jid :
String
) :
Bool
function
load() :
Void
dynamic
function
onAdd(i :
xmpp.roster.Item
) :
Void
Item got added to the roster
dynamic
function
onAsk(i :
xmpp.roster.Item
) :
Void
Incoming presence subscription request
dynamic
function
onError(e :
jabber.XMPPError
) :
Void
A roster manipulation error occured
dynamic
function
onLoad() :
Void
Roster got loaded
dynamic
function
onRemove(i :
xmpp.roster.Item
) :
Void
Item got removed from your roster
dynamic
function
onSubscribed(i :
xmpp.roster.Item
) :
Void
Subscribed to the presence of the contact
dynamic
function
onSubscription(jid :
String
) :
Void
Contact subscribed to your presence
dynamic
function
onUnsubscribed(i :
xmpp.roster.Item
) :
Void
Unsubscribed presence of the contact
dynamic
function
onUnsubscription(i :
xmpp.roster.Item
) :
Void
Contact unsubscribed from your presence
dynamic
function
onUpdate(i :
xmpp.roster.Item
) :
Void
Item got updated
function
removeItem(jid :
String
) :
Bool
Remove entry from your roster
function
subscribe(jid :
String
) :
Bool
Subscribe to the presence of the entity. You will get presence updates from this entity (if confirmed).
function
unsubscribe(jid :
String
, ?cancelSubscription :
Bool
) :
Bool
Unsubscribe from entities presence. The entity will no longer recieve presence updates.
static
var
defaultSubscriptionMode :
RosterSubscriptionMode
Back
|
Index