Skip to content

API.md

Latest commit

 

History

History
176 lines (90 loc) · 3.36 KB

API.md

File metadata and controls

176 lines (90 loc) · 3.36 KB
Raw

RTM Client Unity SDK API Docs

Index

[TOC]

Current Version

public static readonly string com.fpnn.rtm.RTMConfig.SDKVersion = "1.0.0";

Init & Config SDK

Initialize and configure RTM SDK, and dependent FPNN SDK.

PLease refer：Init & Config FPNN SDK & RTM SDK

RTM Client

Overview

  • Namespace

      com.fpnn.rtm

  • Declaration

      public class RTMClient

Constructors

public RTMClient(string endpoint, long projectId, long uid, RTMQuestProcessor serverPushProcessor, bool autoRelogin = true)

  • endpoint:

    RTM servers endpoint. Please get your project endpoint from RTM Console.

  • pid:

    Project ID. Please get your project id from RTM Console.

  • uid:

    User id assigned by your project.

  • serverPushProcessor:

    Instance of events processor inheriting com.fpnn.rtm.RTMQuestProcessor.

    Please refer Event Process

  • autoRelogin:

    Enable auto-relogin when connection lost after first successful login if user's token is available and user isn't forbidden.

Properties

  • ConnectTimeout

      public int ConnectTimeout { get; set; }

    Connecting/Login timeout for this RTMClient instance. Default is 0, meaning using the global config.

  • public int QuestTimeout

      public int QuestTimeout { get; set; }

    Quest timeout for this RTMClient instance. Default is 0, meaning using the global config.

  • public int Pid

      public int Pid { get; }

    Project ID.

  • public int Uid

      public int Uid { get; }

    User ID assigned by you project.

  • public RTMClient.ClientStatus Status

      public RTMClient.ClientStatus Status { get; }

    RTM client current status.

    Values:

    • ClientStatus.Closed
    • ClientStatus.Connecting
    • ClientStatus.Connected

  • public com.fpnn.common.ErrorRecorder ErrorRecorder

      public com.fpnn.common.ErrorRecorder ErrorRecorder { set; }

    Config the ErrorRecorder instance for this RTMClient. Default is null.

Structures

Please refer RTM Structures

Delegates

Please refer RTM Delegates

Event Process

Please refer Event Process

Methods

Login & Logout Functions

Please refer Login & Logout Functions

RTM System Functions

Please refer RTM System Functions

Chat Functions

Please refer Chat Functions

Conversation Functions

Please refer Conversation Functions

Value-Added Functions

Please refer Value-Added Functions

Messages Functions

Please refer Messages Functions

Audio Functions

Please refer Audio Functions

Audio Native Functions

Please refer Audio Native Functions

Files Functions

Please refer Files Functions

Friends Functions

Please refer Friends Functions

Groups Functions

Please refer Groups Functions

Rooms Functions

Please refer Rooms Functions

Users Functions

Please refer Users Functions

Data Functions

Please refer Data Functions

RTC

Please refer RTC

Error Codes

RTM SDK Error Codes
FPNN SDK (Transport Layer) Error Codes