IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

BuddyId Property

This is the jabber id of the buddy.

Syntax

 xmpp.getBuddyId(index, [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 getBuddyId([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 setBuddyId([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 the jabber id of the buddy.

After a Sync event is fired, this property will contain the user id associated with the corresponding entry in the buddy list. If a buddy has multiple entries (e.g., if the buddy is listed in several groups) more than one entry will be the same.

The size of the array is controlled by the BuddyCount property.

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

Data Type

String

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0