| Alexandre Lision | 67916dd | 2014-01-24 13:33:04 -0500 | [diff] [blame] | 1 | |
| 2 |
|
| 3 | Buddy (Presence)
|
| 4 | ================
|
| 5 | This class represents a remote buddy (a person, or a SIP endpoint).
|
| 6 | To use the Buddy class, application DOES NOT need to subclass it unless application wants to get the notifications on buddy state change.
|
| 7 |
|
| 8 | Subscribe to Buddy's Presence Status
|
| 9 | ---------------------------------------------------------
|
| 10 | To subscribe to buddy's presence status, you need to add a buddy object, install callback to handle buddy's event, and start subscribing to buddy's presence status. The snippet below shows a sample code to achieve these::
|
| 11 |
|
| 12 | class MyBuddyCallback(pjsua.BuddyCallback):
|
| 13 | def __init__(self, buddy=None):
|
| 14 | pjsua.BuddyCallback.__init__(self, buddy)
|
| 15 |
|
| 16 | def on_state(self):
|
| 17 | print "Buddy", self.buddy.info().uri, "is",
|
| 18 | print self.buddy.info().online_text
|
| 19 |
|
| 20 | try:
|
| 21 | uri = '"Alice" <sip:alice@example.com>'
|
| 22 | buddy = acc.add_buddy(uri, cb=MyBuddyCallback())
|
| 23 | buddy.subscribe()
|
| 24 |
|
| 25 | except pjsua.Error, err:
|
| 26 | print 'Error adding buddy:', err
|
| 27 |
|
| 28 | For more information please see Buddy class and BuddyCallback class reference documentation.
|
| 29 |
|
| 30 | Responding to Presence Subscription Request
|
| 31 |
|
| 32 | By default, incoming presence subscription to an account will be accepted automatically. You will probably want to change this behavior, for example only to automatically accept subscription if it comes from one of the buddy in the buddy list, and for anything else prompt the user if he/she wants to accept the request.
|
| 33 |
|
| 34 | This can be done by implementing the on_incoming_subscribe() method of the AccountCallback class.
|
| 35 |
|
| 36 | Changing Account's Presence Status
|
| 37 |
|
| 38 | The Account class provides two methods to change account's presence status:
|
| 39 |
|
| 40 | set_basic_status() can be used to set basic account's presence status (i.e. available or not available).
|
| 41 | set_presence_status() can be used to set both the basic presence status and some extended information (e.g. busy, away, on the phone, etc.).
|
| 42 | When the presence status is changed, the account will publish the new status to all of its presence subscriber, either with PUBLISH request or SUBSCRIBE request, or both, depending on account configuration.
|
| 43 |
|