public interface FriendList
FriendList
object representing a list of friends.Modifier and Type | Interface and Description |
---|---|
static class |
FriendList.Status |
static class |
FriendList.SyncStatus |
Modifier and Type | Method and Description |
---|---|
FriendList.Status |
addFriend(Friend lf)
Add a friend to a friend list.
|
void |
addListener(FriendListListener listener) |
FriendList.Status |
addLocalFriend(Friend lf)
Add a friend to a friend list.
|
void |
enableSubscriptions(boolean enabled)
Enable subscription to NOTIFYes of all friends list.
|
void |
exportFriendsAsVcard4File(java.lang.String vcardFile)
Creates and export
Friend objects from FriendList to a file
using vCard 4 format. |
Friend |
findFriendByAddress(Address address)
Find a friend in the friend list using a LinphoneAddress.
|
Friend |
findFriendByRefKey(java.lang.String refKey)
Find a friend in the friend list using a ref key.
|
Friend |
findFriendByUri(java.lang.String uri)
Find a friend in the friend list using an URI string.
|
Friend[] |
findFriendsByAddress(Address address)
Find all friends in the friend list using a LinphoneAddress.
|
Friend[] |
findFriendsByUri(java.lang.String uri)
Find all friends in the friend list using an URI string.
|
Core |
getCore()
Returns the
Core object attached to this LinphoneFriendList. |
java.lang.String |
getDisplayName()
Get the display name of the friend list.
|
Friend[] |
getFriends()
Retrieves the list of
Friend from this LinphoneFriendList. |
Address |
getRlsAddress()
Get the RLS (Resource List Server) URI associated with the friend list to
subscribe to these friends presence.
|
java.lang.String |
getRlsUri()
Get the RLS (Resource List Server) URI associated with the friend list to
subscribe to these friends presence.
|
java.lang.String |
getUri()
Get the URI associated with the friend list.
|
java.lang.Object |
getUserData()
Gets the object stored in this object user's data
|
int |
importFriendsFromVcard4Buffer(java.lang.String vcardBuffer)
Creates and adds
Friend objects to FriendList from a buffer
that contains the vCard(s) to parse. |
int |
importFriendsFromVcard4File(java.lang.String vcardFile)
Creates and adds
Friend objects to FriendList from a file that
contains the vCard(s) to parse. |
boolean |
isSubscriptionBodyless()
Get wheter the subscription of the friend list is bodyless or not.
|
void |
notifyPresence(PresenceModel presence)
Notify our presence to all the friends in the friend list that have subscribed
to our presence directly (not using a RLS).
|
FriendList.Status |
removeFriend(Friend lf)
Remove a friend from a friend list.
|
void |
removeListener(FriendListListener listener) |
void |
setDisplayName(java.lang.String displayName)
Set the display name of the friend list.
|
void |
setListener(FriendListListener listener) |
void |
setRlsAddress(Address rlsAddr)
Set the RLS (Resource List Server) URI associated with the friend list to
subscribe to these friends presence.
|
void |
setRlsUri(java.lang.String rlsUri)
Set the RLS (Resource List Server) URI associated with the friend list to
subscribe to these friends presence.
|
void |
setSubscriptionBodyless(boolean bodyless)
Set wheter the subscription of the friend list is bodyless or not.
|
void |
setUri(java.lang.String uri)
Set the URI associated with the friend list.
|
void |
setUserData(java.lang.Object data)
Sets the object to store in this object user's data
|
boolean |
subscriptionsEnabled()
Gets whether subscription to NOTIFYes of all friends list are enabled or not.
|
void |
synchronizeFriendsFromServer()
Starts a CardDAV synchronization using value set using
linphone_friend_list_set_uri.
|
void |
updateDirtyFriends()
Goes through all the
Friend that are dirty and does a CardDAV PUT to
update the server. |
void |
updateRevision(int rev)
Sets the revision from the last synchronization.
|
void |
updateSubscriptions()
Update presence subscriptions for the entire list.
|
Core getCore()
Core
object attached to this LinphoneFriendList.Core
objectjava.lang.String getDisplayName()
void setDisplayName(java.lang.String displayName)
displayName
- The new display name of the friend list.boolean isSubscriptionBodyless()
Address getRlsAddress()
void setRlsAddress(Address rlsAddr)
rlsAddr
- The RLS URI to associate with the friend list.java.lang.String getRlsUri()
void setRlsUri(java.lang.String rlsUri)
rlsUri
- The RLS URI to associate with the friend list.void setSubscriptionBodyless(boolean bodyless)
boolean subscriptionsEnabled()
void enableSubscriptions(boolean enabled)
enabled
- should subscription be enabled or notjava.lang.String getUri()
void setUri(java.lang.String uri)
uri
- The URI to associate with the friend list.FriendList.Status addFriend(Friend lf)
lf
- Friend
object to add to the friend list.FriendList.Status addLocalFriend(Friend lf)
lf
- Friend
object to add to the friend list.void exportFriendsAsVcard4File(java.lang.String vcardFile)
Friend
objects from FriendList
to a file
using vCard 4 format.vcardFile
- the path to a file that will contain the vCardsFriend findFriendByAddress(Address address)
Friend findFriendByRefKey(java.lang.String refKey)
refKey
- The ref key string of the friend we want to search for.Friend
if found, null otherwise.Friend findFriendByUri(java.lang.String uri)
uri
- A string containing the URI of the friend we want to search for.Friend
if found, null otherwise.Friend[] findFriendsByAddress(Address address)
Friend[] findFriendsByUri(java.lang.String uri)
int importFriendsFromVcard4Buffer(java.lang.String vcardBuffer)
Friend
objects to FriendList
from a buffer
that contains the vCard(s) to parse.vcardBuffer
- the buffer that contains the vCard(s) to parseint importFriendsFromVcard4File(java.lang.String vcardFile)
Friend
objects to FriendList
from a file that
contains the vCard(s) to parse.vcardFile
- the path to a file that contains the vCard(s) to parsevoid notifyPresence(PresenceModel presence)
presence
- PresenceModel
object.FriendList.Status removeFriend(Friend lf)
lf
- Friend
object to remove from the friend list.void synchronizeFriendsFromServer()
void updateDirtyFriends()
Friend
that are dirty and does a CardDAV PUT to
update the server.void updateRevision(int rev)
rev
- The revisionvoid updateSubscriptions()
void addListener(FriendListListener listener)
void removeListener(FriendListListener listener)
void setListener(FriendListListener listener)
void setUserData(java.lang.Object data)
data
- the object to storejava.lang.Object getUserData()