IPWorks IoT 2020 Node.js Edition

Questions / Feedback?

AuthMethods Property

Controls how the class authenticates itself with the XMPP server.

Syntax

 xmpp.getAuthMethods([callback])
 xmpp.setAuthMethods( authMethods, [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 getAuthMethods([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 setAuthMethods([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

AuthMethods is a comma-separated list of authentication methods to be enabled on the class, listed in order of preference. When authenticating, the class will pick the first method in the list that is supported by the server.

The special value * (default) may be supplied to cause the class to enable all supported authentication methods in order of presumed security. The XMPP class currently supports the following values for AuthMethods, listed in order of most secure to least secure:

  • SASL/DIGEST-MD5
  • AuthIQ/Digest
  • SASL/PLAIN
  • AuthIQ/Plaintext
  • SASL/NTLM

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IoT 2020 Node.js Edition - Version 20.0 [Build 8265]