DOCSEARCHbyAlgolia
Submit Docs

ShengWang SDK API Reference

website·Indexed 31 days ago

https://im.shengwang.cn/document/android/document_index.html

API documentation for ShengWang's instant messaging SDKs, including HyphenateChatSDK (versions 4.24.1 and 5.0.0) and ShengwangChatSDK (version 1.3.2). Provides technical references for iOS, Android, and HarmonyOS, covering chatroom options, local notification management, and message body types such as voice, image, and video.

Tokens
3.7M
Snippets
19.3K
Records
26.7K
Agent score
50%

What's inside ShengWang SDK

  1. Overview of Message Pinning in HarmonyOS SDK

    Message pinning allows users to fix specific messages to the top of a conversation for quick access by all participants. This feature is supported in single-user chats, group chats, and chat rooms. Note that this feature requires activation via Agora business contact. By default, a single conversation can have up to 20 pinned messages (expandable to 100 via business contact).

  2. Overview of Android Chat UIKit common features

    v2

    The Android Chat UIKit provides a comprehensive set of IM features out-of-the-box, including:

    • Conversation Management: Conversation lists, creating new sessions, and creating/managing groups (including admin permissions for member management and group settings).
    • User Interaction: User/Contact lists, contact name cards, and file sharing (documents, images, videos).
    • Messaging Enhancements: Voice messages, unread message counts, delivery receipts (server/recipient status), and read receipts.
    • Content Control: Message auditing to ensure compliance with community guidelines and laws.

  3. Overview of Agora IM SDK and UIKit

    The Instant Messaging (IM) SDK provides core functionality for implementing one-on-one chats, group chats, and chat rooms. The Single/Group Chat UIKit is an open-source UI component library that provides common pages and UI elements to help developers quickly build the application's chat interface.

  4. Overview of Unity IM SDK V1.3.2 Features

    The Unity IM SDK V1.3.2 is the first official release and provides a comprehensive suite of instant messaging capabilities, including:

    • Messaging: Sending and receiving messages across single chats, group chats, chat rooms, and sub-zones.
    • Message Management: Capabilities to fetch, recall, search, modify, pin, import, and insert messages.
    • Conversation Management: Handling conversation lists, read receipts, unread counts, pinning, marking, and deletion.
    • Group and Chat Room Management: Creating and dissolving groups/rooms, retrieving details and member lists, and managing member permissions (whitelist, blacklist, and muting).
    • Sub-zones: Creating discussion threads (sub-zones) based on specific group messages, including joining, exiting, and managing sub-zone messages.
    • Group/Room Attributes: Modifying names, descriptions, announcements, and managing custom key-value attributes for chat rooms.
    • User Relationships: Managing friends (add/delete), setting friend remarks, and maintaining friend blacklists.
    • User Profiles: Managing user attributes such as nicknames, avatars, email, phone, gender, signatures, and birthdays.
    • Presence/Online Status: Subscribing to and unsubscribing from user online status, sending custom online statuses, and querying the list of subscribed users.

  5. Overview of LiveCommunicationKit for iOS VoIP Calls

    The LiveCommunicationManager is a singleton class used to manage iOS VoIP calls. It integrates Apple's PushKit and LiveCommunicationKit frameworks to provide a complete VoIP solution including incoming call notifications, call management, and audio session control. For optimal performance when using LiveCommunicationKit, it is recommended to configure the Instant Messaging (IM) service for automatic login.

  6. Overview of IM message types

    The IM SDK supports several message types identified by the type parameter. The message body is a JSONArray structure where the content varies based on the specified type.
    // Supported type values:
// "txt"    - Text message
// "loc"    - Location message
// "cmd"    - Pass-through (command) message
// "img"    - Image message
// "audio"  - Audio message
// "video"  - Video message
// "file"   - File message
// "custom" - Custom message

  7. Overview of Android Telecom Framework for VoIP

    The Android Telecom framework manages all device calls, including traditional SIM-based calls and VoIP calls. It handles caller ID, answering, and hanging up, and notifies the relevant applications. When integrated with CallKit, it provides a system-level calling experience, ensuring that incoming calls can trigger the native system call interface even if the app process is not currently running (e.g., when awakened by an FCM push notification).

  8. Introduction to Shengwang Chat UIKit for Flutter

    v2
    The Shengwang Chat UIKit for Flutter is a UI component library built on top of the IM SDK. It provides a set of ready-to-use components to implement core IM features such as conversation lists, chat interfaces, and contact lists, allowing developers to rapidly build IM applications tailored to their business needs.

  10. Overview of Shengwang IM SDK for uni-app

    The Shengwang IM SDK for uni-app provides a technical solution for integrating instant messaging into mini-programs. It supports account registration/login, basic messaging (text, images, voice, video, audio, files, transparent transmission, and extended messages), group chat rooms, personal settings, and voice recording.

    Supported platforms include:

    • WeChat Mini Program
    • Alipay Mini Program
    • QQ Mini Program
    • Baidu Mini Program
    • Douyin Mini Program (requires base library version below 1.70.0)
    • Native Android and iOS compiled via uni-app

  11. Overview of Group Member Namecards

    v4
    Group member namecards are personalized display information for users within specific groups (e.g., department, position, or project role). These are group-specific and do not affect the user's identity in other groups. Starting from SDK v4.20.0, the Android SDK supports setting, local querying, server-side retrieval, and change listening for these namecards.

  12. Overview of CallKit for iOS

    CallKit is a real-time audio and video calling framework that deeply integrates Agora's Instant Messaging (IM) and Real-Time Communication (RTC) services. It enables developers to quickly implement high-quality 1-on-1 and group audio/video calls for scenarios such as online classrooms, customer service centers, and remote medical consultations.