highras/rtm

php-sdk for RTM

rtm-server-sdk-php

Requirements

• PHP >= 5.4, _(*1)

• ext-mcrypt, _(*2)

• ext-gmp, _(*3)

• ext-msgpack, _(*4)

Installations

The preferred way to install this sdk is through composer., _(*5)

Note: Check the composer.json for this SDK's requirements and dependencies. Read this web tip /wiki on setting the minimum-stability settings for your application's composer.json., _(*6)

Either run, _(*7)

$ php composer.phar require highras/rtm $LATEST_VERSION

or add, _(*8)

"highras/rtm": $LATEST_VERSION

to the require section of your composer.json file., _(*9)

Notice

• Before using the SDK, please make sure the server time is correct, RTM-Server will check whether the signature time has expired

API

• __construct($pid, $secretKey, $endpoint, $timeout = 5000, $autoReconnect = true): RTMServerClient Construct, _(*10)

  • pid: (int) Project ID
  • secretKey: (string) Secret key
  • endpoint: (string) Server endpoint
  • timeout: (int) connection timeout(ms)
  • autoReconnect: (bool) support auto reconnect

• enableEncryptor($peerPubData): Enable encrypted connection, _(*11)

  • peerPubData: (string) Certificate content

• enableEncryptorByFile($file): Enable encrypted connection, _(*12)

  • file: (string) Certificate file path

Token Functions

Please refer Token Functions, _(*13)

User Functions

Please refer User Functions, _(*14)

Room Functions

Please refer Room Functions, _(*15)

Group Functions

Please refer Group Functions, _(*16)

Friend Functions

Please refer Friend Functions, _(*17)

Message Functions

Please refer Message Functions, _(*18)

Chat Functions

Please refer Chat Functions, _(*19)

File Functions

Please refer File Functions, _(*20)

Device Functions

Please refer Device Functions, _(*21)

Data Functions

Please refer Data Functions, _(*22)

RTC Functions

Please refer RTC Functions, _(*23)

Error Codes

Please refer RTM Error Codes, _(*24)

Please refer FPNN Error Codes, _(*25)