BuddyGroup Property

This is a comma-separated list of the buddy's associated groups.

Syntax

 xmpp.getBuddyGroup(index, [callback])
 xmpp.setBuddyGroup(index,  buddyGroup, [callback])

Default Value

""

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 getBuddyGroup([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 setBuddyGroup([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 comma-separated list of the buddy's associated groups.

After the Sync event has fired, this property will contain a comma-separated list of groups for the associated BuddyId. Changing this value will cause the buddy's group associations to change. Setting it to the empty string ("") will cause the buddy to be completely disassociated from all groups.

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 not available at design time.

Data Type

String