Skip to content

Latest commit

 

History

History
258 lines (170 loc) · 5.43 KB

Room.md

File metadata and controls

258 lines (170 loc) · 5.43 KB
Raw

RTM Server-End Python SDK Room API Docs

Index

[TOC]

API

add_room_member

add room member
add_room_member(rid, uid, callback = None, timeout = 0)

params:

  • rid: (Required | int) room id
  • uid: (Optional | int) user id
  • callback: (Optional | a sub-class of BasicCallback ) used in async implementation
class BasicCallback(object):
    def callback(self, error_code):
        pass

return:

  • in async implementation, return None
  • in sync implementation:
    • error_code: (int) the error code when quest is fail, or FPNN_ERROR.FPNN_EC_OK when success

delete_room_member

delete room member
delete_room_member(rid, uid, callback = None, timeout = 0)

params:

  • rid: (Required | int) room id
  • uid: (Optional | int) user id
  • callback: (Optional | a sub-class of BasicCallback ) used in async implementation
class BasicCallback(object):
    def callback(self, error_code):
        pass

return:

  • in async implementation, return None
  • in sync implementation:
    • error_code: (int) the error code when quest is fail, or FPNN_ERROR.FPNN_EC_OK when success

set_room_info

set room public and private info
set_room_info(rid, oinfo = None, pinfo = None, callback = None, timeout = 0)

params:

  • rid: (Required | int) room id
  • oinfo: (Optional | str) public info
  • pinfo: (Optional | str) private info
  • callback: (Optional | a sub-class of BasicCallback ) used in async implementation
class BasicCallback(object):
    def callback(self, error_code):
        pass

return:

  • in async implementation, return None
  • in sync implementation:
    • error_code: (int) the error code when quest is fail, or FPNN_ERROR.FPNN_EC_OK when success

get_room_info

get room public and private info
get_room_info(rid, callback = None, timeout = 0)

params:

  • rid: (Required | int) room id
  • callback: (Optional | a sub-class of GetRoomInfoCallback ) used in async implementation
class GetRoomInfoCallback(object):
    def callback(self, oinfo, pinfo, error):
        pass

return:

  • in async implementation, return None
  • in sync implementation:
    • oinfo: (int) public info
    • pinfo: (int) private info
    • error_code: (int) the error code when quest is fail, or FPNN_ERROR.FPNN_EC_OK when success

add_room_ban

add room ban
add_room_ban(rid, uid, btime, callback = None, timeout = 0)

params:

  • rid: (Required | int) room id, if rid = None, is baned for all room
  • uid: (Required | int) user id
  • btime: (Optional | int) ban time in second
  • callback: (Optional | a sub-class of BasicCallback ) used in async implementation
class BasicCallback(object):
    def callback(self, error_code):
        pass

return:

  • in async implementation, return None
  • in sync implementation:
    • error_code: (int) the error code when quest is fail, or FPNN_ERROR.FPNN_EC_OK when success

remove_room_ban

remove room ban
remove_room_ban(rid, uid, callback = None, timeout = 0)

params:

  • rid: (Required | int) room id, if rid = None, is removed ban for all room
  • uid: (Required | int) user id
  • callback: (Optional | a sub-class of BasicCallback ) used in async implementation
class BasicCallback(object):
    def callback(self, error_code):
        pass

return:

  • in async implementation, return None
  • in sync implementation:
    • error_code: (int) the error code when quest is fail, or FPNN_ERROR.FPNN_EC_OK when success

is_ban_of_room

check is ban of a room
is_ban_of_room(rid, uid, callback = None, timeout = 0)

params:

  • rid: (Required | int) room id
  • uid: (Required | int) user id
  • callback: (Optional | a sub-class of IsBanOfRoomCallback ) used in async implementation
class IsBanOfRoomCallback(object):
    def callback(self, ok, error_code):
        pass

return:

  • in async implementation, return None
  • in sync implementation:
    • ok: (bool) is ban
    • error_code: (int) the error code when quest is fail, or FPNN_ERROR.FPNN_EC_OK when success

get room members

get room members
get_room_members(rid, callback = None, timeout = 0)

params:

  • rid: (Required | int) room id
  • callback: (Optional | a sub-class of GetRoomMembersCallback ) used in async implementation
class GetRoomMembersCallback(object):
    def callback(self, uids, error_code):
        pass

return:

  • in async implementation, return None
  • in sync implementation:
    • uids: (list) member uids list
    • error_code: (int) the error code when quest is fail, or FPNN_ERROR.FPNN_EC_OK when success

get room members count

get room members count
get_room_count(rids, callback = None, timeout = 0)

params:

  • rids: (Required | [int]) room ids list
  • callback: (Optional | a sub-class of GetRoomCountCallback ) used in async implementation
class GetRoomCountCallback(object):
    def callback(self, count, error_code):
        pass

return:

  • in async implementation, return None
  • in sync implementation:
    • count: (map<int, int>) rid => members count in room
    • error_code: (int) the error code when quest is fail, or FPNN_ERROR.FPNN_EC_OK when success