This class is used to pass challenge error information back to the application. The application
creates an instance of this type and then calls one of the following API procedures to have
the class initialized:
GetChallengeErrorData(Int32, VoipMediaEngine..::.CHALLENGE_ERROR_DATA),
GetRegisterChallengeErrorData(VoipMediaEngine..::.CHALLENGE_ERROR_DATA),
GetSubscribeChallengeErrorData(UInt32, VoipMediaEngine..::.CHALLENGE_ERROR_DATA), and
GetNotifyChallengeErrorData(UInt32, VoipMediaEngine..::.CHALLENGE_ERROR_DATA).
Normally your application will initialize the media engine with authentication credentials using the
AddAuthorizationCredentials(String, String, String) API procedure. When the media engine performs an
operation, it handles all of the details associated with processing an authentication challenge.
If an authentication challenge response cannot be constructed based on the authorization credentials
previously specified, then the media engine returns a value or sends an event to your application
signaling that a challenge operation could not successfully be performed.
The challenge error data is available when you receive the API return values:
API Return Value | Comments |
---|
SipEventNotifyNotAccepted | When you receive this return value as the result of calling the SendEventNotification(String, UInt32, UInt32%) API procedure, call the GetNotifyChallengeErrorData(UInt32, VoipMediaEngine..::.CHALLENGE_ERROR_DATA) API procedure to get the challenge error data for the NOTIFY operation. |
SipRegisterAuthorizationError | If your application performs registrations using the and EnableSipRegisterServer(String, Boolean, Boolean, String, UInt32, UInt32, UInt32, UInt32, Boolean) API procedure and receives this return value, call the GetRegisterChallengeErrorData(VoipMediaEngine..::.CHALLENGE_ERROR_DATA) API procedure to get the challenge error data for the register operation. |
Challenge error data is also available when you receive the following events:
Namespace:
LanScape
Assembly:
LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
Visual Basic (Declaration) |
---|
Public Class CHALLENGE_ERROR_DATA _
Implements IDisposable |
Visual C++ |
---|
public ref class CHALLENGE_ERROR_DATA : IDisposable |
J# |
---|
public class CHALLENGE_ERROR_DATA implements IDisposable |
Inheritance Hierarchy
See Also