BuddySubscription Property

This is a list of the subscription status for the buddy.

Syntax

 xmpp.getBuddySubscription(index, [callback])

Possible Values

  0 (stNone), 
  1 (stTo), 
  2 (stFrom), 
  3 (stBoth), 
  4 (stRemove)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getBuddySubscription([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setBuddySubscription([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This is a list of the subscription status for the buddy.

After a Sync event is fired, this property will contain all of the types of subscriptions for the buddy. They are defined as follows:

The index parameter specifies the index of the item in the array. The size of the array is controlled by the BuddyCount property.

This property is read-only and not available at design time.

Data Type

Integer