Sample code

Here we provide you with a sample application to experience ZEGOCLOUD's In-app Chat, and also describe how to run the sample code.

Prerequisites

Go to ZEGOCLOUD Admin Console to create a new project, and get the AppID and AppSign of your project.

Environment-specific requirements:

• Install Unity 2021.3.18f1c1 or later version. If not installed, you can download Unity Hub from Unity official website, and then install the Unity version you need (if you are not sure, it is recommended to install the latest LTS version). When downloading, it is recommended to select the corresponding Platforms module according to your needs, for example, installing on Windows:

  

• Select the corresponding development environment or device according to the platform that the sample code needs to run on:

  • To run the Android sample source code: requires devices or emulators that support Android 4.1 or later versions and JDK 1.6 or later versions (it is recommended to use a real device). If it is a real device, please enable the "allow debugging" option.
  • To run the iOS sample source code: requires Xcode 13.0 or later versions and devices or emulators that support iOS 9.0 or later versions (it is recommended to use a real device).
  • To run the macOS sample source code: requires macOS 10.11 or later versions.
  • To run the Windows sample source code: requires Windows 7 or later versions and Visual Studio 2015 or later versions installed.
  • Ensure that the device running the program is connected to the network properly.
  • Ensure that Unity has installed the Platforms module corresponding to the platform that needs to be run. If Unity has been installed but the corresponding Platforms module has not been installed, you need to download the corresponding module. For example, on Windows: Open Unity Hub, click the "Install" option on the left, select the Unity version to be installed, click the icon in the upper right corner, select the "Add modules" option, and select the corresponding module in the pop-up window for download.

Sample code structure

The following structure shows the subdirectory structure of the In-app Chat sample code:

Unity3dDemo
└─Assets
    ├─Scenes                  // Scenes
    │   Conv.unity             // Conversation scene
    │   Conv.unity.meta
    │   Login.unity            // Login scene
    │   Login.unity.meta
    │
    └─Scripts                 // Demo scripts
        CallOptionList.cs       // Call invitation options
        CallOptionList.cs.meta
        ConvCreateOptionList.cs  // Create conversation
        ConvCreateOptionList.cs.meta
        ConvPage.cs             // Conversation page
        ConvPage.cs.meta
        ConvPageOptionList.cs    // Switch conversation, room, and group lists
        ConvPageOptionList.cs.meta
        GroupPage.cs            // Group-related logic
        GroupPage.cs.meta
        KeyCenter.cs            // Fill in AppID and AppSign
        KeyCenter.cs.meta
        LoginClicked.cs         // Login
        LoginClicked.cs.meta
        MemberPage.cs           // Group and room member list-related logic
        MemberPage.cs.meta
        MessagePage.cs          // Message-related logic
        MessagePage.cs.meta
        RoomPage.cs             // Room-related logic
        RoomPage.cs.meta
    │
    └─ZIM                     // ZIM Unity SDK package
        ├─Plugins             // Import ZIM plugins for various platforms
        │  ├─Android
        │  ├─iOS
        │  ├─macOS
        │  └─windows
        └─Scripts              // C# encapsulation of ZIM plugin interface

Run the sample code

1. Refer to the "Integrating SDK" section in Getting started to complete the SDK integration.

2. Fill in the "appID" and "appSign" mentioned in the previous "Prerequisites" section in the Assets/Scripts/KeyCenter.cs file.

   

3. Click the "Projects" tab in Unity Hub, click "Open" in the upper right corner, and open the downloaded sample source code.

4. After opening the sample source code, an Editor version not installed prompt may pop up, indicating that the Unity Editor version used by the sample source code project cannot be found. At this time, select another Unity Editor version and specify the Unity version you are using.

   

5. After opening the project, select "Login" and "Conv" under the "Project > Assets > Scenes" directory in the lower left corner and drag them to the "Hierarchy" window in the upper left corner.

   

6. In the top menu bar, select "File > Build Settings."

   

7. Make sure that "Scenes/Login" is 0 and "Scenes/Conv" is 1 in "Scenes in Build," select the platform in "Platform," and switch to the platform you want to run.

   

8. Start running.