Jabber SDK 11.8.3 API Documentation

Jabber SDK 11.8.3 API Documentation with all CWIC library features, Tutorials, Classes and Global.

Jabber SDK 11.8.3 API Documentation

Introduction

The Jabber SDK 11.8.3 API Documentation covers all the features of the CWIC library. The following topics are well described and help you to go through the documentation more easily:

• Tutorials - Rich tutorials on how to use CWIC library.
• Classes - Well documented list of objects that can be used.
• Global - Enums that describe states and errors.

API

CWIC library API is accessed through global cwic object. All features of CWIC are exposed through different types of controllers:

• SystemController - Offers API for initialization and authorization.
• LoginController - Offers API for login and authentication.
• TelephonyController - Offers API for managing telephony devices and telephony conversations.
• MultimediaController - Offers API for managing media devices, ringtones and monitors (used in screen share feature).
• CertificateController - Offers API for handling invalid certificates.
• WindowController - Offers API for handling video windows.

In snippet below it is shown how to access each of these controllers :

 // All controllers are accessed through global cwic object.
 cwic.SystemController;
 cwic.LoginController;
 cwic.TelephonyController;
 cwic.MultimediaController;
 cwic.CertificateController;
 cwic.WindowController;

Backward Compatibility

As of 11.8.0 release, old API that was used before 11.7.0 will no longer be available. If there is a need for using both APIs, please refer to the 11.7.0 release.

Tutorials

The best place to begin are tutorials. They cover every aspect of the library. Here is the order in which tutorials should be read:

1. Initialization And Authorization
2. Login and Authentication
3. Connecting And Using Telephony Device
4. Telephony Conversation And It's Features
5. Call Pickup
6. Media Devices And Ringtones
7. Handling Invalid Certificates
8. Video Windows And Video Rendering
9. Monitor Selection And Highlight (Screen Share)

Classes

1. Camera
2. CertificateController
3. ConversationWindow
4. DeskPhone
5. InvalidCertificate
6. LoginController
7. MediaDevice
8. Microphone
9. Monitor
10. MultimediaController
11. NativeConversationWindow
12. NativePreviewWindow
13. NativeScreenShareWindow
14. NativeVideoWindow
15. PreviewWindow
16. RemotePhone
17. Ringer
18. Ringtone
19. ScreenShareWindow
20. SoftPhone
21. Speaker
22. SystemController
23. SystemControllerCapabilities
24. TelephonyController
25. TelephonyControllerCapabilities
26. TelephonyConversation
27. TelephonyConversationCapabilities
28. TelephonyConversationStates
29. TelephonyDevice
30. WindowController

Global

The following Enums that describe states and errors. For more information, refer Global of Jabber Web SDK API.

1. AuthenticationError
2. AuthenticationState
3. HuntGroupState
4. RemoteCameraAction
5. SystemError
6. TelephonyConnectionState
7. WindowType