IPWorks WebSockets 2020 macOS Edition

Questions / Feedback?

AuthScheme Property

The authentication scheme to use when server authorization is required.

Syntax

public var authScheme: WebsocketclientAuthSchemes {
get {...}
set {...} }

public enum WebsocketclientAuthSchemes: Int32 { case authBasic = 0 case authDigest = 1 case authProprietary = 2 case authNone = 3 case authNtlm = 4 case authNegotiate = 5 case authOAuth = 6 }

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the class will attempt basic authentication. If AuthScheme is set to authDigest (1), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property.

If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization property.

Note that, if you set the Authorization property and AuthScheme is not authProprietary or authOAuth, the AuthScheme will be set automatically to authProprietary (2) by the control.

For security purposes, changing the value of this property will cause the class to clear the values of User, Password and Authorization.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks WebSockets 2020 macOS Edition - Version 20.0 [Build 7941]