Group.md

RTM Server-End Python SDK Group API Docs

Index

[TOC]

API

add_group_members

add group members

add_group_members(gid, uids, callback = None, timeout = 0)

params:

• gid: (Required | int) group id
• uids: (Optional | [int]) user id list
• 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_group_members

delete group members

delete_group_members(gid, uids, callback = None, timeout = 0)

params:

• gid: (Required | int) group id
• uids: (Optional | [int]) user id list
• 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_group

delete group

delete_group(gid, callback = None, timeout = 0)

params:

• gid: (Required | int) group 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

get_group_members

get group members

get_group_members(gid, callback = None, timeout = 0)

params:

• gid: (Required | int) group id
• callback: (Optional | a sub-class of GetGroupMembersCallback ) used in async implementation

class GetGroupMembersCallback(object):
    def callback(self, uids, error_code):
        pass

return:

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

is_group_member

check is group member

is_group_member(gid, uid, callback = None, timeout = 0)

params:

• gid: (Required | int) group id
• uid: (Required | int) user id
• callback: (Optional | a sub-class of IsGroupMemberCallback ) used in async implementation

class IsGroupMemberCallback(object):
    def callback(self, ok, error_code):
        pass

return:

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

get_user_groups

get user groups

get_user_groups(uid, callback = None, timeout = 0)

params:

• uid: (Required | int) user id
• callback: (Optional | a sub-class of GetUserGroupsCallback ) used in async implementation

class GetUserGroupsCallback(object):
    def callback(self, gids, error_code):
        pass

return:

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

add_group_ban

add group ban

add_group_ban(gid, uid, btime, callback = None, timeout = 0)

params:

• gid: (Required | int) group id, if gid = None, is baned for all group
• 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_group_ban

remove group ban

remove_group_ban(gid, uid, callback = None, timeout = 0)

params:

• gid: (Required | int) group id, if gid = None, is removed ban for all group
• 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_group

check is ban of a group

is_ban_of_group(gid, uid, callback = None, timeout = 0)

params:

• gid: (Required | int) group id
• uid: (Required | int) user id
• callback: (Optional | a sub-class of IsBanOfGroupCallback ) used in async implementation

class IsBanOfGroupCallback(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

set_group_info

set group public and private info

set_group_info(gid, oinfo = None, pinfo = None, callback = None, timeout = 0)

params:

• gid: (Required | int) group 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_group_info

get group public and private info

get_group_info(gid, callback = None, timeout = 0)

params:

• gid: (Required | int) group id
• callback: (Optional | a sub-class of GetGroupInfoCallback ) used in async implementation

class GetGroupInfoCallback(object):
    def callback(self, oinfo, pinfo, error_code):
        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