Skip to main content

​
V5 Calls SDK Documentation - Implementation Tasks

​
Overview

Implementation plan for creating V5 Calls SDK documentation for all platforms, using Android as the reference implementation.

​
Tasks

  • 1. Create documentation file structure
    • Created docs/calls/android/ directory with all documentation files
    • Requirements: Story 1
  • 2. Create Overview documentation
    • 2.1 Create overview.mdx with SDK introduction, features, architecture, prerequisites
    • Requirements: Story 1
  • 3. Create Getting Started documentation
    • 3.1 Create setup.mdx with installation, permissions, CallAppSettings initialization
    • 3.2 Create authentication.mdx with login (UID, authToken), logout, getLoggedInUser
    • Requirements: Story 1
  • 4. Create Join Session documentation
    • 4.1 Create join-session.mdx with generateToken(), SessionSettings, joinSession() and CallSession lifecycle (consolidated)
    • Requirements: Story 2
  • 5. Create Session Methods documentation
    • 5.1 Create audio-controls.mdx with muteAudio, unMuteAudio, setAudioMode
    • 5.2 Create video-controls.mdx with pauseVideo, resumeVideo, switchCamera
    • 5.3 Create recording.mdx with startRecording, stopRecording
    • 5.4 Create participant-actions.mdx with muteParticipant, pauseParticipantVideo, pin/unpin
    • 5.5 Create layout-ui.mdx with setLayout, PiP methods, setChatButtonUnreadCount
    • 5.6 Create session-control.mdx with leaveSession, raiseHand, lowerHand, isSessionActive
    • Requirements: Story 3
  • 6. Create Listeners documentation
    • 6.1 Create session-status-listener.mdx with all SessionStatusListener callbacks
    • 6.2 Create participant-event-listener.mdx with all ParticipantEventListener callbacks
    • 6.3 Create media-events-listener.mdx with all MediaEventsListener callbacks
    • 6.4 Create button-click-listener.mdx with all ButtonClickListener callbacks
    • 6.5 Create layout-listener.mdx with all LayoutListener callbacks
    • Requirements: Story 4
  • 7. Update docs.json navigation
    • 7.1 Add Calls SDK product section with Android dropdown
    • 7.2 Add navigation groups: Overview, Getting Started, Join Session, Session Methods, Listeners
    • 7.3 Add Sample App and Changelog external links for Android
    • Requirements: Story 5
  • 8. Checkpoint - Review Android documentation
    • Ensure all pages are accessible and properly linked
    • Verify code examples compile correctly
  • 9. Create iOS documentation
    • 9.1 Create docs/calls/ios/setup.mdx with CocoaPods/SPM installation, permissions, initialization
    • 9.2 Create docs/calls/ios/authentication.mdx with Swift login/logout examples
    • 9.3 Create docs/calls/ios/join-session.mdx with generateToken, SessionSettings, joinSession
    • 9.4 Create docs/calls/ios/audio-controls.mdx with Swift audio control examples
    • 9.5 Create docs/calls/ios/video-controls.mdx with Swift video control examples
    • 9.6 Create docs/calls/ios/recording.mdx with Swift recording examples
    • 9.7 Create docs/calls/ios/participant-actions.mdx with Swift participant management
    • 9.8 Create docs/calls/ios/layout-ui.mdx with Swift layout/UI examples
    • 9.9 Create docs/calls/ios/session-control.mdx with Swift session control examples
    • 9.10 Create listener documentation files (session-status, participant-event, media-events, button-click, layout)
    • 9.11 Update docs/calls/ios/overview.mdx with full iOS SDK overview
    • 9.12 Add iOS navigation to docs.json
    • Requirements: Stories 1-5
  • 10. Create React Native documentation
    • 10.1 Create docs/calls/react-native/setup.mdx with npm/yarn installation, native setup
    • 10.2 Create docs/calls/react-native/authentication.mdx with TypeScript login/logout examples
    • 10.3 Create docs/calls/react-native/join-session.mdx with generateToken, SessionSettings, joinSession
    • 10.4 Create docs/calls/react-native/audio-controls.mdx with TypeScript audio control examples
    • 10.5 Create docs/calls/react-native/video-controls.mdx with TypeScript video control examples
    • 10.6 Create docs/calls/react-native/recording.mdx with TypeScript recording examples
    • 10.7 Create docs/calls/react-native/participant-actions.mdx with TypeScript participant management
    • 10.8 Create docs/calls/react-native/layout-ui.mdx with TypeScript layout/UI examples
    • 10.9 Create docs/calls/react-native/session-control.mdx with TypeScript session control examples
    • 10.10 Create listener documentation files
    • 10.11 Update docs/calls/react-native/overview.mdx with full React Native SDK overview
    • 10.12 Add React Native navigation to docs.json
    • Requirements: Stories 1-5
  • 11. Create JavaScript documentation
    • 11.1 Create docs/calls/javascript/setup.mdx with npm/CDN installation, initialization
    • 11.2 Create docs/calls/javascript/authentication.mdx with JavaScript login/logout examples
    • 11.3 Create docs/calls/javascript/join-session.mdx with generateToken, SessionSettings, joinSession
    • 11.4 Create docs/calls/javascript/audio-controls.mdx with JavaScript audio control examples
    • 11.5 Create docs/calls/javascript/video-controls.mdx with JavaScript video control examples
    • 11.6 Create docs/calls/javascript/recording.mdx with JavaScript recording examples
    • 11.7 Create docs/calls/javascript/participant-actions.mdx with JavaScript participant management
    • 11.8 Create docs/calls/javascript/layout-ui.mdx with JavaScript layout/UI examples
    • 11.9 Create docs/calls/javascript/session-control.mdx with JavaScript session control examples
    • 11.10 Create listener documentation files
    • 11.11 Update docs/calls/javascript/overview.mdx with full JavaScript SDK overview
    • 11.12 Add JavaScript navigation to docs.json
    • Requirements: Stories 1-5
  • 12. Create Flutter documentation
    • 12.1 Create docs/calls/flutter/setup.mdx with pub.dev installation, native setup
    • 12.2 Create docs/calls/flutter/authentication.mdx with Dart login/logout examples
    • 12.3 Create docs/calls/flutter/join-session.mdx with generateToken, SessionSettings, joinSession
    • 12.4 Create docs/calls/flutter/audio-controls.mdx with Dart audio control examples
    • 12.5 Create docs/calls/flutter/video-controls.mdx with Dart video control examples
    • 12.6 Create docs/calls/flutter/recording.mdx with Dart recording examples
    • 12.7 Create docs/calls/flutter/participant-actions.mdx with Dart participant management
    • 12.8 Create docs/calls/flutter/layout-ui.mdx with Dart layout/UI examples
    • 12.9 Create docs/calls/flutter/session-control.mdx with Dart session control examples
    • 12.10 Create listener documentation files
    • 12.11 Update docs/calls/flutter/overview.mdx with full Flutter SDK overview
    • 12.12 Add Flutter navigation to docs.json
    • Requirements: Stories 1-5
  • 13. Create Ionic documentation
    • 13.1 Create docs/calls/ionic/setup.mdx with npm installation, Capacitor/Cordova setup
    • 13.2 Create docs/calls/ionic/authentication.mdx with TypeScript login/logout examples
    • 13.3 Create docs/calls/ionic/join-session.mdx with generateToken, SessionSettings, joinSession
    • 13.4 Create docs/calls/ionic/audio-controls.mdx with TypeScript audio control examples
    • 13.5 Create docs/calls/ionic/video-controls.mdx with TypeScript video control examples
    • 13.6 Create docs/calls/ionic/recording.mdx with TypeScript recording examples
    • 13.7 Create docs/calls/ionic/participant-actions.mdx with TypeScript participant management
    • 13.8 Create docs/calls/ionic/layout-ui.mdx with TypeScript layout/UI examples
    • 13.9 Create docs/calls/ionic/session-control.mdx with TypeScript session control examples
    • 13.10 Create listener documentation files
    • 13.11 Update docs/calls/ionic/overview.mdx with full Ionic SDK overview
    • 13.12 Add Ionic navigation to docs.json
    • Requirements: Stories 1-5
  • 14. Final checkpoint
    • Verify all platform documentation is complete
    • Test navigation across all platforms
    • Ensure consistent structure and terminology

​
Current File Structure

docs/calls/
├── android/
│   ├── overview.mdx ✓
│   ├── setup.mdx ✓
│   ├── authentication.mdx ✓
│   ├── join-session.mdx ✓ (includes generate-token & session-settings)
│   ├── audio-controls.mdx ✓
│   ├── video-controls.mdx ✓
│   ├── recording.mdx ✓
│   ├── participant-actions.mdx ✓
│   ├── layout-ui.mdx ✓
│   ├── session-control.mdx ✓
│   ├── session-status-listener.mdx ✓
│   ├── participant-event-listener.mdx ✓
│   ├── media-events-listener.mdx ✓
│   ├── button-click-listener.mdx ✓
│   ├── layout-listener.mdx ✓
│   ├── listeners.mdx ✓
│   └── session-methods.mdx ✓
├── ios/
│   └── overview.mdx (placeholder)
├── react-native/
│   └── overview.mdx (placeholder)
├── javascript/
│   └── overview.mdx (placeholder)
├── flutter/
│   └── overview.mdx (placeholder)
├── ionic/
│   └── overview.mdx (placeholder)
└── api/
    ├── overview.mdx ✓
    ├── get-call.mdx ✓
    └── list-calls.mdx ✓

​
Notes

  • Android documentation is complete and serves as the reference implementation
  • docs.json navigation needs to be updated to include the Calls SDK section
  • Other platforms (iOS, React Native, JavaScript, Flutter, Ionic) need full documentation
  • Use SDK source code for accurate method signatures and parameters
  • Include platform-appropriate code examples (Kotlin/Java for Android, Swift for iOS, etc.)
  • Ensure consistent structure across all platforms