Skip to content

API Documentation

Table of Contents

HaiFriendAddRequest

* 添加A、B两人为好友


接口名

/hai/friend/add 错误码


success error.alert

Generated from protobuf message plugin.HaiFriendAddRequest

  • Full name: \Akaxin\Proto\Plugin\HaiFriendAddRequest
  • Parent class:

__construct

HaiFriendAddRequest::__construct(  )

getSiteUserId

用户1

HaiFriendAddRequest::getSiteUserId(  ): string

Generated from protobuf field string site_user_id = 1;


setSiteUserId

用户1

HaiFriendAddRequest::setSiteUserId( string $var ): $this

Generated from protobuf field string site_user_id = 1;

Parameters:

Parameter Type Description
$var string

getFriendSiteUserId

用户2

HaiFriendAddRequest::getFriendSiteUserId(  ): string

Generated from protobuf field string friend_site_user_id = 2;


setFriendSiteUserId

用户2

HaiFriendAddRequest::setFriendSiteUserId( string $var ): $this

Generated from protobuf field string friend_site_user_id = 2;

Parameters:

Parameter Type Description
$var string

HaiFriendAddResponse

Generated from protobuf message plugin.HaiFriendAddResponse

  • Full name: \Akaxin\Proto\Plugin\HaiFriendAddResponse
  • Parent class:

__construct

HaiFriendAddResponse::__construct(  )

HaiFriendApplyRequest

* A->B 发送好友请求


接口名

/hai/friend/apply 错误码


success error.alert

Generated from protobuf message plugin.HaiFriendApplyRequest

  • Full name: \Akaxin\Proto\Plugin\HaiFriendApplyRequest
  • Parent class:

__construct

HaiFriendApplyRequest::__construct(  )

getSiteUserId

发起好友请求的用户

HaiFriendApplyRequest::getSiteUserId(  ): string

Generated from protobuf field string site_user_id = 1;


setSiteUserId

发起好友请求的用户

HaiFriendApplyRequest::setSiteUserId( string $var ): $this

Generated from protobuf field string site_user_id = 1;

Parameters:

Parameter Type Description
$var string

getFriendSiteUserId

目标用户

HaiFriendApplyRequest::getFriendSiteUserId(  ): string

Generated from protobuf field string friend_site_user_id = 2;


setFriendSiteUserId

目标用户

HaiFriendApplyRequest::setFriendSiteUserId( string $var ): $this

Generated from protobuf field string friend_site_user_id = 2;

Parameters:

Parameter Type Description
$var string

getApplyReason

申请理由

HaiFriendApplyRequest::getApplyReason(  ): string

Generated from protobuf field string apply_reason = 3;


setApplyReason

申请理由

HaiFriendApplyRequest::setApplyReason( string $var ): $this

Generated from protobuf field string apply_reason = 3;

Parameters:

Parameter Type Description
$var string

HaiFriendApplyResponse

Generated from protobuf message plugin.HaiFriendApplyResponse

  • Full name: \Akaxin\Proto\Plugin\HaiFriendApplyResponse
  • Parent class:

__construct

HaiFriendApplyResponse::__construct(  )

HaiFriendRelationsRequest

* 获取某用户与其他用户的好友关系


接口名

/hai/friend/relations 错误码


success error.alert

Generated from protobuf message plugin.HaiFriendRelationsRequest

  • Full name: \Akaxin\Proto\Plugin\HaiFriendRelationsRequest
  • Parent class:

__construct

HaiFriendRelationsRequest::__construct(  )

getSiteUserId

Generated from protobuf field string site_user_id = 1;

HaiFriendRelationsRequest::getSiteUserId(  ): string

setSiteUserId

Generated from protobuf field string site_user_id = 1;

HaiFriendRelationsRequest::setSiteUserId( string $var ): $this

Parameters:

Parameter Type Description
$var string

getTargetSiteUserId

需要查询关系的用户ID

HaiFriendRelationsRequest::getTargetSiteUserId(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated string target_site_user_id = 2;


setTargetSiteUserId

需要查询关系的用户ID

HaiFriendRelationsRequest::setTargetSiteUserId( array<mixed,string>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated string target_site_user_id = 2;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

HaiFriendRelationsResponse

Generated from protobuf message plugin.HaiFriendRelationsResponse

  • Full name: \Akaxin\Proto\Plugin\HaiFriendRelationsResponse
  • Parent class:

__construct

HaiFriendRelationsResponse::__construct(  )

getUserProfile

查询的结果

HaiFriendRelationsResponse::getUserProfile(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated .core.UserRelationProfile user_profile = 1;


setUserProfile

查询的结果

HaiFriendRelationsResponse::setUserProfile( array<mixed,\Akaxin\Proto\Core\UserRelationProfile>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated .core.UserRelationProfile user_profile = 1;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

HaiGroupAddMemberRequest

* 向群里添加群成员


如果此人已在群里,返回成功而不是失败 接口名


/hai/group/addMember 错误码


success error.alert

Generated from protobuf message plugin.HaiGroupAddMemberRequest

  • Full name: \Akaxin\Proto\Plugin\HaiGroupAddMemberRequest
  • Parent class:

__construct

HaiGroupAddMemberRequest::__construct(  )

getGroupId

群组ID

HaiGroupAddMemberRequest::getGroupId(  ): string

Generated from protobuf field string group_id = 1;


setGroupId

群组ID

HaiGroupAddMemberRequest::setGroupId( string $var ): $this

Generated from protobuf field string group_id = 1;

Parameters:

Parameter Type Description
$var string

getMemberSiteUserId

群组中需要增加的用户ID

HaiGroupAddMemberRequest::getMemberSiteUserId(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated string member_site_user_id = 2;


setMemberSiteUserId

群组中需要增加的用户ID

HaiGroupAddMemberRequest::setMemberSiteUserId( array<mixed,string>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated string member_site_user_id = 2;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

HaiGroupAddMemberResponse

Generated from protobuf message plugin.HaiGroupAddMemberResponse

  • Full name: \Akaxin\Proto\Plugin\HaiGroupAddMemberResponse
  • Parent class:

__construct

HaiGroupAddMemberResponse::__construct(  )

HaiGroupCheckMemberRequest

* 检查用户是否在某群里


接口名

/hai/group/checkMember 错误码


success error.alert

Generated from protobuf message plugin.HaiGroupCheckMemberRequest

  • Full name: \Akaxin\Proto\Plugin\HaiGroupCheckMemberRequest
  • Parent class:

__construct

HaiGroupCheckMemberRequest::__construct(  )

getGroupId

群组ID

HaiGroupCheckMemberRequest::getGroupId(  ): string

Generated from protobuf field string group_id = 1;


setGroupId

群组ID

HaiGroupCheckMemberRequest::setGroupId( string $var ): $this

Generated from protobuf field string group_id = 1;

Parameters:

Parameter Type Description
$var string

getSiteUserId

待检查的成员id

HaiGroupCheckMemberRequest::getSiteUserId(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated string site_user_id = 2;


setSiteUserId

待检查的成员id

HaiGroupCheckMemberRequest::setSiteUserId( array<mixed,string>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated string site_user_id = 2;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

HaiGroupCheckMemberResponse

Generated from protobuf message plugin.HaiGroupCheckMemberResponse

  • Full name: \Akaxin\Proto\Plugin\HaiGroupCheckMemberResponse
  • Parent class:

__construct

HaiGroupCheckMemberResponse::__construct(  )

getMembersSiteUserId

请求在这个群里的成员( 肯定是request参数的子集 )

HaiGroupCheckMemberResponse::getMembersSiteUserId(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated string members_site_user_id = 1;


setMembersSiteUserId

请求在这个群里的成员( 肯定是request参数的子集 )

HaiGroupCheckMemberResponse::setMembersSiteUserId( array<mixed,string>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated string members_site_user_id = 1;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

HaiGroupDeleteRequest

* 删除群组


接口名

/hai/group/delete 错误码


success error.alert

Generated from protobuf message plugin.HaiGroupDeleteRequest

  • Full name: \Akaxin\Proto\Plugin\HaiGroupDeleteRequest
  • Parent class:

__construct

HaiGroupDeleteRequest::__construct(  )

getGroupId

删除的群组ID

HaiGroupDeleteRequest::getGroupId(  ): string

Generated from protobuf field string group_id = 1;


setGroupId

删除的群组ID

HaiGroupDeleteRequest::setGroupId( string $var ): $this

Generated from protobuf field string group_id = 1;

Parameters:

Parameter Type Description
$var string

HaiGroupDeleteResponse

Generated from protobuf message plugin.HaiGroupDeleteResponse

  • Full name: \Akaxin\Proto\Plugin\HaiGroupDeleteResponse
  • Parent class:

__construct

HaiGroupDeleteResponse::__construct(  )

HaiGroupListRequest

* 获取群组列表


接口名

/hai/group/list 错误码


success error.alert

Generated from protobuf message plugin.HaiGroupListRequest

  • Full name: \Akaxin\Proto\Plugin\HaiGroupListRequest
  • Parent class:

__construct

HaiGroupListRequest::__construct(  )

getPageNumber

第几页

HaiGroupListRequest::getPageNumber(  ): integer

Generated from protobuf field int32 page_number = 1;


setPageNumber

第几页

HaiGroupListRequest::setPageNumber( integer $var ): $this

Generated from protobuf field int32 page_number = 1;

Parameters:

Parameter Type Description
$var integer

getPageSize

每页的条数,默认100

HaiGroupListRequest::getPageSize(  ): integer

Generated from protobuf field int32 page_size = 2;


setPageSize

每页的条数,默认100

HaiGroupListRequest::setPageSize( integer $var ): $this

Generated from protobuf field int32 page_size = 2;

Parameters:

Parameter Type Description
$var integer

getSiteUserId

查询谁的群组,为空则查询所有。

HaiGroupListRequest::getSiteUserId(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated string site_user_id = 3;


setSiteUserId

查询谁的群组,为空则查询所有。

HaiGroupListRequest::setSiteUserId( array<mixed,string>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated string site_user_id = 3;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

HaiGroupListResponse

Generated from protobuf message plugin.HaiGroupListResponse

  • Full name: \Akaxin\Proto\Plugin\HaiGroupListResponse
  • Parent class:

__construct

HaiGroupListResponse::__construct(  )

getGroupProfile

用户的群列表

HaiGroupListResponse::getGroupProfile(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated .core.SimpleGroupProfile group_profile = 1;


setGroupProfile

用户的群列表

HaiGroupListResponse::setGroupProfile( array<mixed,\Akaxin\Proto\Core\SimpleGroupProfile>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated .core.SimpleGroupProfile group_profile = 1;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

getPageTotalNum

一共多少页

HaiGroupListResponse::getPageTotalNum(  ): integer

Generated from protobuf field int32 page_total_num = 2;


setPageTotalNum

一共多少页

HaiGroupListResponse::setPageTotalNum( integer $var ): $this

Generated from protobuf field int32 page_total_num = 2;

Parameters:

Parameter Type Description
$var integer

HaiGroupMembersRequest

* 获取群成员


接口名

/hai/group/members 错误码


success error.alert

Generated from protobuf message plugin.HaiGroupMembersRequest

  • Full name: \Akaxin\Proto\Plugin\HaiGroupMembersRequest
  • Parent class:

__construct

HaiGroupMembersRequest::__construct(  )

getGroupId

群组ID

HaiGroupMembersRequest::getGroupId(  ): string

Generated from protobuf field string group_id = 1;


setGroupId

群组ID

HaiGroupMembersRequest::setGroupId( string $var ): $this

Generated from protobuf field string group_id = 1;

Parameters:

Parameter Type Description
$var string

getPageNumber

分页:第几页

HaiGroupMembersRequest::getPageNumber(  ): integer

Generated from protobuf field int32 page_number = 2;


setPageNumber

分页:第几页

HaiGroupMembersRequest::setPageNumber( integer $var ): $this

Generated from protobuf field int32 page_number = 2;

Parameters:

Parameter Type Description
$var integer

getPageSize

分页:每页条数,默认100

HaiGroupMembersRequest::getPageSize(  ): integer

Generated from protobuf field int32 page_size = 3;


setPageSize

分页:每页条数,默认100

HaiGroupMembersRequest::setPageSize( integer $var ): $this

Generated from protobuf field int32 page_size = 3;

Parameters:

Parameter Type Description
$var integer

HaiGroupMembersResponse

Generated from protobuf message plugin.HaiGroupMembersResponse

  • Full name: \Akaxin\Proto\Plugin\HaiGroupMembersResponse
  • Parent class:

__construct

HaiGroupMembersResponse::__construct(  )

getGroupMember

群组成员信息

HaiGroupMembersResponse::getGroupMember(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated .core.GroupMemberProfile group_member = 1;


setGroupMember

群组成员信息

HaiGroupMembersResponse::setGroupMember( array<mixed,\Akaxin\Proto\Core\GroupMemberProfile>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated .core.GroupMemberProfile group_member = 1;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

getPageTotalNum

分页总数

HaiGroupMembersResponse::getPageTotalNum(  ): integer

Generated from protobuf field int32 page_total_num = 2;


setPageTotalNum

分页总数

HaiGroupMembersResponse::setPageTotalNum( integer $var ): $this

Generated from protobuf field int32 page_total_num = 2;

Parameters:

Parameter Type Description
$var integer

HaiGroupNonmembersRequest

* 分页获非群成员


接口名

/hai/group/nonmembers 错误码


success error.alert

Generated from protobuf message plugin.HaiGroupNonmembersRequest

  • Full name: \Akaxin\Proto\Plugin\HaiGroupNonmembersRequest
  • Parent class:

__construct

HaiGroupNonmembersRequest::__construct(  )

getSiteUserId

以谁的视角获取这份数据

HaiGroupNonmembersRequest::getSiteUserId(  ): string

Generated from protobuf field string site_user_id = 1;


setSiteUserId

以谁的视角获取这份数据

HaiGroupNonmembersRequest::setSiteUserId( string $var ): $this

Generated from protobuf field string site_user_id = 1;

Parameters:

Parameter Type Description
$var string

getGroupId

群组ID

HaiGroupNonmembersRequest::getGroupId(  ): string

Generated from protobuf field string group_id = 2;


setGroupId

群组ID

HaiGroupNonmembersRequest::setGroupId( string $var ): $this

Generated from protobuf field string group_id = 2;

Parameters:

Parameter Type Description
$var string

getPageNumber

分页:第几页

HaiGroupNonmembersRequest::getPageNumber(  ): integer

Generated from protobuf field int32 page_number = 3;


setPageNumber

分页:第几页

HaiGroupNonmembersRequest::setPageNumber( integer $var ): $this

Generated from protobuf field int32 page_number = 3;

Parameters:

Parameter Type Description
$var integer

getPageSize

分页:每页条数,默认100

HaiGroupNonmembersRequest::getPageSize(  ): integer

Generated from protobuf field int32 page_size = 4;


setPageSize

分页:每页条数,默认100

HaiGroupNonmembersRequest::setPageSize( integer $var ): $this

Generated from protobuf field int32 page_size = 4;

Parameters:

Parameter Type Description
$var integer

HaiGroupNonmembersResponse

Generated from protobuf message plugin.HaiGroupNonmembersResponse

  • Full name: \Akaxin\Proto\Plugin\HaiGroupNonmembersResponse
  • Parent class:

__construct

HaiGroupNonmembersResponse::__construct(  )

getGroupMember

群组成员信息

HaiGroupNonmembersResponse::getGroupMember(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated .core.GroupMemberProfile group_member = 1;


setGroupMember

群组成员信息

HaiGroupNonmembersResponse::setGroupMember( array<mixed,\Akaxin\Proto\Core\GroupMemberProfile>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated .core.GroupMemberProfile group_member = 1;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

getPageTotalNum

分页总数

HaiGroupNonmembersResponse::getPageTotalNum(  ): integer

Generated from protobuf field int32 page_total_num = 2;


setPageTotalNum

分页总数

HaiGroupNonmembersResponse::setPageTotalNum( integer $var ): $this

Generated from protobuf field int32 page_total_num = 2;

Parameters:

Parameter Type Description
$var integer

HaiGroupProfileRequest

* 获取群组资料


接口名

/hai/group/profile 错误码


success error.alert

Generated from protobuf message plugin.HaiGroupProfileRequest

  • Full name: \Akaxin\Proto\Plugin\HaiGroupProfileRequest
  • Parent class:

__construct

HaiGroupProfileRequest::__construct(  )

getGroupId

当前用户获取群组ID的资料信息

HaiGroupProfileRequest::getGroupId(  ): string

Generated from protobuf field string group_id = 1;


setGroupId

当前用户获取群组ID的资料信息

HaiGroupProfileRequest::setGroupId( string $var ): $this

Generated from protobuf field string group_id = 1;

Parameters:

Parameter Type Description
$var string

HaiGroupProfileResponse

Generated from protobuf message plugin.HaiGroupProfileResponse

  • Full name: \Akaxin\Proto\Plugin\HaiGroupProfileResponse
  • Parent class:

__construct

HaiGroupProfileResponse::__construct(  )

getProfile

群组资料页信息

HaiGroupProfileResponse::getProfile(  ): \Akaxin\Proto\Core\GroupProfile

Generated from protobuf field .core.GroupProfile profile = 1;


setProfile

群组资料页信息

HaiGroupProfileResponse::setProfile( \Akaxin\Proto\Core\GroupProfile $var ): $this

Generated from protobuf field .core.GroupProfile profile = 1;

Parameters:

Parameter Type Description
$var \Akaxin\Proto\Core\GroupProfile

HaiGroupRemoveMemberRequest

* 删除群成员


接口名

/hai/group/removeMember 错误码


success error.alert

Generated from protobuf message plugin.HaiGroupRemoveMemberRequest

  • Full name: \Akaxin\Proto\Plugin\HaiGroupRemoveMemberRequest
  • Parent class:

__construct

HaiGroupRemoveMemberRequest::__construct(  )

getGroupId

群组ID

HaiGroupRemoveMemberRequest::getGroupId(  ): string

Generated from protobuf field string group_id = 1;


setGroupId

群组ID

HaiGroupRemoveMemberRequest::setGroupId( string $var ): $this

Generated from protobuf field string group_id = 1;

Parameters:

Parameter Type Description
$var string

getGroupMember

需要删除的群组成员!!不能删除管理员

HaiGroupRemoveMemberRequest::getGroupMember(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated string group_member = 3;


setGroupMember

需要删除的群组成员!!不能删除管理员

HaiGroupRemoveMemberRequest::setGroupMember( array<mixed,string>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated string group_member = 3;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

HaiGroupRemoveMemberResponse

Generated from protobuf message plugin.HaiGroupRemoveMemberResponse

  • Full name: \Akaxin\Proto\Plugin\HaiGroupRemoveMemberResponse
  • Parent class:

__construct

HaiGroupRemoveMemberResponse::__construct(  )

HaiGroupUpdateProfileRequest

* 更新群资料


接口名

/hai/group/updateProfile 错误码


success error.alert

Generated from protobuf message plugin.HaiGroupUpdateProfileRequest

  • Full name: \Akaxin\Proto\Plugin\HaiGroupUpdateProfileRequest
  • Parent class:

__construct

HaiGroupUpdateProfileRequest::__construct(  )

getGroupId

显示的设置群组ID

HaiGroupUpdateProfileRequest::getGroupId(  ): string

Generated from protobuf field string group_id = 1;


setGroupId

显示的设置群组ID

HaiGroupUpdateProfileRequest::setGroupId( string $var ): $this

Generated from protobuf field string group_id = 1;

Parameters:

Parameter Type Description
$var string

getProfile

需要更新的群组资料

HaiGroupUpdateProfileRequest::getProfile(  ): \Akaxin\Proto\Core\GroupProfile

Generated from protobuf field .core.GroupProfile profile = 2;


setProfile

需要更新的群组资料

HaiGroupUpdateProfileRequest::setProfile( \Akaxin\Proto\Core\GroupProfile $var ): $this

Generated from protobuf field .core.GroupProfile profile = 2;

Parameters:

Parameter Type Description
$var \Akaxin\Proto\Core\GroupProfile

HaiGroupUpdateProfileResponse

Generated from protobuf message plugin.HaiGroupUpdateProfileResponse

  • Full name: \Akaxin\Proto\Plugin\HaiGroupUpdateProfileResponse
  • Parent class:

__construct

HaiGroupUpdateProfileResponse::__construct(  )

HaiMessageProxyRequest

* 代发消息


接口名

/hai/message/proxy 错误码


success error.alert

Generated from protobuf message plugin.HaiMessageProxyRequest

  • Full name: \Akaxin\Proto\Plugin\HaiMessageProxyRequest
  • Parent class:

__construct

HaiMessageProxyRequest::__construct(  )

getProxyMsg

代理发送的消息请求

HaiMessageProxyRequest::getProxyMsg(  ): \Akaxin\Proto\Site\ImCtsMessageRequest

Generated from protobuf field .site.ImCtsMessageRequest proxy_msg = 1;


setProxyMsg

代理发送的消息请求

HaiMessageProxyRequest::setProxyMsg( \Akaxin\Proto\Site\ImCtsMessageRequest $var ): $this

Generated from protobuf field .site.ImCtsMessageRequest proxy_msg = 1;

Parameters:

Parameter Type Description
$var \Akaxin\Proto\Site\ImCtsMessageRequest

HaiMessageProxyResponse

Generated from protobuf message plugin.HaiMessageProxyResponse

  • Full name: \Akaxin\Proto\Plugin\HaiMessageProxyResponse
  • Parent class:

__construct

HaiMessageProxyResponse::__construct(  )

HaiPluginAddRequest

* 新增扩展


接口名

/hai/plugin/add 错误码


success error.alert error.plugin.no_permission

Generated from protobuf message plugin.HaiPluginAddRequest

  • Full name: \Akaxin\Proto\Plugin\HaiPluginAddRequest
  • Parent class:

__construct

HaiPluginAddRequest::__construct(  )

getPlugin

需要增加的插件

HaiPluginAddRequest::getPlugin(  ): \Akaxin\Proto\Core\Plugin

Generated from protobuf field .core.Plugin plugin = 1;


setPlugin

需要增加的插件

HaiPluginAddRequest::setPlugin( \Akaxin\Proto\Core\Plugin $var ): $this

Generated from protobuf field .core.Plugin plugin = 1;

Parameters:

Parameter Type Description
$var \Akaxin\Proto\Core\Plugin

HaiPluginAddResponse

Generated from protobuf message plugin.HaiPluginAddResponse

  • Full name: \Akaxin\Proto\Plugin\HaiPluginAddResponse
  • Parent class:

__construct

HaiPluginAddResponse::__construct(  )

HaiPluginDeleteRequest

* 删除插件


接口名

/hai/plugin/delete 错误码


success error.alert error.plugin.no_permission

Generated from protobuf message plugin.HaiPluginDeleteRequest

  • Full name: \Akaxin\Proto\Plugin\HaiPluginDeleteRequest
  • Parent class:

__construct

HaiPluginDeleteRequest::__construct(  )

getPluginId

需要删除的插件ID

HaiPluginDeleteRequest::getPluginId(  ): string

Generated from protobuf field string plugin_id = 1;


setPluginId

需要删除的插件ID

HaiPluginDeleteRequest::setPluginId( string $var ): $this

Generated from protobuf field string plugin_id = 1;

Parameters:

Parameter Type Description
$var string

HaiPluginDeleteResponse

Generated from protobuf message plugin.HaiPluginDeleteResponse

  • Full name: \Akaxin\Proto\Plugin\HaiPluginDeleteResponse
  • Parent class:

__construct

HaiPluginDeleteResponse::__construct(  )

HaiPluginListRequest

* 获取插件列表


接口名

/hai/plugin/list 错误码


success error.alert error.plugin.no_permission

Generated from protobuf message plugin.HaiPluginListRequest

  • Full name: \Akaxin\Proto\Plugin\HaiPluginListRequest
  • Parent class:

__construct

HaiPluginListRequest::__construct(  )

getPageNumber

分页:第几页

HaiPluginListRequest::getPageNumber(  ): integer

Generated from protobuf field int32 page_number = 1;


setPageNumber

分页:第几页

HaiPluginListRequest::setPageNumber( integer $var ): $this

Generated from protobuf field int32 page_number = 1;

Parameters:

Parameter Type Description
$var integer

getPageSize

分页:每页条数 默认100

HaiPluginListRequest::getPageSize(  ): integer

Generated from protobuf field int32 page_size = 2;


setPageSize

分页:每页条数 默认100

HaiPluginListRequest::setPageSize( integer $var ): $this

Generated from protobuf field int32 page_size = 2;

Parameters:

Parameter Type Description
$var integer

HaiPluginListResponse

Generated from protobuf message plugin.HaiPluginListResponse

  • Full name: \Akaxin\Proto\Plugin\HaiPluginListResponse
  • Parent class:

__construct

HaiPluginListResponse::__construct(  )

getPlugin

获取插件列表数据

HaiPluginListResponse::getPlugin(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated .core.Plugin plugin = 1;


setPlugin

获取插件列表数据

HaiPluginListResponse::setPlugin( array<mixed,\Akaxin\Proto\Core\Plugin>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated .core.Plugin plugin = 1;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

getPageTotalNum

总分页数量

HaiPluginListResponse::getPageTotalNum(  ): integer

Generated from protobuf field int32 page_total_num = 2;


setPageTotalNum

总分页数量

HaiPluginListResponse::setPageTotalNum( integer $var ): $this

Generated from protobuf field int32 page_total_num = 2;

Parameters:

Parameter Type Description
$var integer

HaiPluginProfileRequest

* 获取扩展详情


接口名

/hai/plugin/profile 错误码


success error.alert

Generated from protobuf message plugin.HaiPluginProfileRequest

  • Full name: \Akaxin\Proto\Plugin\HaiPluginProfileRequest
  • Parent class:

__construct

HaiPluginProfileRequest::__construct(  )

getPluginId

插件id

HaiPluginProfileRequest::getPluginId(  ): string

Generated from protobuf field string plugin_id = 1;


setPluginId

插件id

HaiPluginProfileRequest::setPluginId( string $var ): $this

Generated from protobuf field string plugin_id = 1;

Parameters:

Parameter Type Description
$var string

HaiPluginProfileResponse

Generated from protobuf message plugin.HaiPluginProfileResponse

  • Full name: \Akaxin\Proto\Plugin\HaiPluginProfileResponse
  • Parent class:

__construct

HaiPluginProfileResponse::__construct(  )

getPlugin

需要更新的插件扩展

HaiPluginProfileResponse::getPlugin(  ): \Akaxin\Proto\Core\Plugin

Generated from protobuf field .core.Plugin plugin = 1;


setPlugin

需要更新的插件扩展

HaiPluginProfileResponse::setPlugin( \Akaxin\Proto\Core\Plugin $var ): $this

Generated from protobuf field .core.Plugin plugin = 1;

Parameters:

Parameter Type Description
$var \Akaxin\Proto\Core\Plugin

HaiPluginUpdateRequest

* 获取扩展详情


编辑插件信息,可以更新所有信息,也可以更新其中部分信息,取决于uri 接口名


/hai/plugin/update ?????? /hai/plugin/updateStatus ?????? 错误码


success error.alert

Generated from protobuf message plugin.HaiPluginUpdateRequest

  • Full name: \Akaxin\Proto\Plugin\HaiPluginUpdateRequest
  • Parent class:

__construct

HaiPluginUpdateRequest::__construct(  )

getPlugin

需要更新的插件扩展

HaiPluginUpdateRequest::getPlugin(  ): \Akaxin\Proto\Core\Plugin

Generated from protobuf field .core.Plugin plugin = 1;


setPlugin

需要更新的插件扩展

HaiPluginUpdateRequest::setPlugin( \Akaxin\Proto\Core\Plugin $var ): $this

Generated from protobuf field .core.Plugin plugin = 1;

Parameters:

Parameter Type Description
$var \Akaxin\Proto\Core\Plugin

HaiPluginUpdateResponse

Generated from protobuf message plugin.HaiPluginUpdateResponse

  • Full name: \Akaxin\Proto\Plugin\HaiPluginUpdateResponse
  • Parent class:

__construct

HaiPluginUpdateResponse::__construct(  )

HaiPushNoticesRequest

* 向全员推送消息通知


接口名

/hai/push/notices 错误码


success error.alert

Generated from protobuf message plugin.HaiPushNoticesRequest

  • Full name: \Akaxin\Proto\Plugin\HaiPushNoticesRequest
  • Parent class:

__construct

HaiPushNoticesRequest::__construct(  )

getSubtitle

push通知的title(副标题),客户端主标题展示站点名称

HaiPushNoticesRequest::getSubtitle(  ): string

Generated from protobuf field string subtitle = 1;


setSubtitle

push通知的title(副标题),客户端主标题展示站点名称

HaiPushNoticesRequest::setSubtitle( string $var ): $this

Generated from protobuf field string subtitle = 1;

Parameters:

Parameter Type Description
$var string

getContent

通知的内容

HaiPushNoticesRequest::getContent(  ): string

Generated from protobuf field string content = 2;


setContent

通知的内容

HaiPushNoticesRequest::setContent( string $var ): $this

Generated from protobuf field string content = 2;

Parameters:

Parameter Type Description
$var string

getPushGoto

通知的跳转,可以为空。

HaiPushNoticesRequest::getPushGoto(  ): string

Generated from protobuf field string push_goto = 3;


setPushGoto

通知的跳转,可以为空。

HaiPushNoticesRequest::setPushGoto( string $var ): $this

Generated from protobuf field string push_goto = 3;

Parameters:

Parameter Type Description
$var string

HaiPushNoticesResponse

Generated from protobuf message plugin.HaiPushNoticesResponse

  • Full name: \Akaxin\Proto\Plugin\HaiPushNoticesResponse
  • Parent class:

__construct

HaiPushNoticesResponse::__construct(  )

HaiSiteGetConfigRequest

* 获取站点的配置


接口名

/hai/site/getConfig 错误码


success error.alert

Generated from protobuf message plugin.HaiSiteGetConfigRequest

  • Full name: \Akaxin\Proto\Plugin\HaiSiteGetConfigRequest
  • Parent class:

__construct

HaiSiteGetConfigRequest::__construct(  )

HaiSiteGetConfigResponse

Generated from protobuf message plugin.HaiSiteGetConfigResponse

  • Full name: \Akaxin\Proto\Plugin\HaiSiteGetConfigResponse
  • Parent class:

__construct

HaiSiteGetConfigResponse::__construct(  )

getSiteConfig

信息配置,Key为SiteConfigKey

HaiSiteGetConfigResponse::getSiteConfig(  ): \Akaxin\Proto\Core\SiteBackConfig

Generated from protobuf field .core.SiteBackConfig site_config = 1;


setSiteConfig

信息配置,Key为SiteConfigKey

HaiSiteGetConfigResponse::setSiteConfig( \Akaxin\Proto\Core\SiteBackConfig $var ): $this

Generated from protobuf field .core.SiteBackConfig site_config = 1;

Parameters:

Parameter Type Description
$var \Akaxin\Proto\Core\SiteBackConfig

HaiSiteUpdateConfigRequest

* 更新站点的配置


接口名

/hai/site/updateConfig 错误码


success error.alert

Generated from protobuf message plugin.HaiSiteUpdateConfigRequest

  • Full name: \Akaxin\Proto\Plugin\HaiSiteUpdateConfigRequest
  • Parent class:

__construct

HaiSiteUpdateConfigRequest::__construct(  )

getSiteConfig

信息配置,Key为SiteConfigKey

HaiSiteUpdateConfigRequest::getSiteConfig(  ): \Akaxin\Proto\Core\SiteBackConfig

Generated from protobuf field .core.SiteBackConfig site_config = 1;


setSiteConfig

信息配置,Key为SiteConfigKey

HaiSiteUpdateConfigRequest::setSiteConfig( \Akaxin\Proto\Core\SiteBackConfig $var ): $this

Generated from protobuf field .core.SiteBackConfig site_config = 1;

Parameters:

Parameter Type Description
$var \Akaxin\Proto\Core\SiteBackConfig

HaiSiteUpdateConfigResponse

Generated from protobuf message plugin.HaiSiteUpdateConfigResponse

  • Full name: \Akaxin\Proto\Plugin\HaiSiteUpdateConfigResponse
  • Parent class:

__construct

HaiSiteUpdateConfigResponse::__construct(  )

HaiUicCreateRequest

* 生成新的邀请码


接口名

/hai/uic/create 错误码


success error.alert

Generated from protobuf message plugin.HaiUicCreateRequest

  • Full name: \Akaxin\Proto\Plugin\HaiUicCreateRequest
  • Parent class:

__construct

HaiUicCreateRequest::__construct(  )

getUicNumber

一次生成的UIC个数

HaiUicCreateRequest::getUicNumber(  ): integer

Generated from protobuf field int32 uic_number = 1;


setUicNumber

一次生成的UIC个数

HaiUicCreateRequest::setUicNumber( integer $var ): $this

Generated from protobuf field int32 uic_number = 1;

Parameters:

Parameter Type Description
$var integer

getUicLength

每个UIC的长度,默认16。长度范围需在10-30之间

HaiUicCreateRequest::getUicLength(  ): integer

Generated from protobuf field int32 uic_length = 2;


setUicLength

每个UIC的长度,默认16。长度范围需在10-30之间

HaiUicCreateRequest::setUicLength( integer $var ): $this

Generated from protobuf field int32 uic_length = 2;

Parameters:

Parameter Type Description
$var integer

HaiUicCreateResponse

Generated from protobuf message plugin.HaiUicCreateResponse

  • Full name: \Akaxin\Proto\Plugin\HaiUicCreateResponse
  • Parent class:

__construct

HaiUicCreateResponse::__construct(  )

getSuccessNumber

成功生成的个数

HaiUicCreateResponse::getSuccessNumber(  ): integer

Generated from protobuf field int32 success_number = 1;


setSuccessNumber

成功生成的个数

HaiUicCreateResponse::setSuccessNumber( integer $var ): $this

Generated from protobuf field int32 success_number = 1;

Parameters:

Parameter Type Description
$var integer

HaiUicInfoRequest

* 获取单个邀请码详情


接口名

/hai/uic/info 错误码


success error.alert

Generated from protobuf message plugin.HaiUicInfoRequest

  • Full name: \Akaxin\Proto\Plugin\HaiUicInfoRequest
  • Parent class:

__construct

HaiUicInfoRequest::__construct(  )

getId

当前uic的id

HaiUicInfoRequest::getId(  ): integer

Generated from protobuf field int32 id = 1;


setId

当前uic的id

HaiUicInfoRequest::setId( integer $var ): $this

Generated from protobuf field int32 id = 1;

Parameters:

Parameter Type Description
$var integer

getUic

uic

HaiUicInfoRequest::getUic(  ): string

Generated from protobuf field string uic = 2;


setUic

uic

HaiUicInfoRequest::setUic( string $var ): $this

Generated from protobuf field string uic = 2;

Parameters:

Parameter Type Description
$var string

HaiUicInfoResponse

Generated from protobuf message plugin.HaiUicInfoResponse

  • Full name: \Akaxin\Proto\Plugin\HaiUicInfoResponse
  • Parent class:

__construct

HaiUicInfoResponse::__construct(  )

getUicInfo

更新的uic信息

HaiUicInfoResponse::getUicInfo(  ): \Akaxin\Proto\Core\UicInfo

Generated from protobuf field .core.UicInfo uic_info = 2;


setUicInfo

更新的uic信息

HaiUicInfoResponse::setUicInfo( \Akaxin\Proto\Core\UicInfo $var ): $this

Generated from protobuf field .core.UicInfo uic_info = 2;

Parameters:

Parameter Type Description
$var \Akaxin\Proto\Core\UicInfo

HaiUicListRequest

* 分页获取邀请码列表


接口名

/hai/uic/list 错误码


success error.alert

Generated from protobuf message plugin.HaiUicListRequest

  • Full name: \Akaxin\Proto\Plugin\HaiUicListRequest
  • Parent class:

__construct

HaiUicListRequest::__construct(  )

getPageNumber

分页:第几页

HaiUicListRequest::getPageNumber(  ): integer

Generated from protobuf field int32 page_number = 1;


setPageNumber

分页:第几页

HaiUicListRequest::setPageNumber( integer $var ): $this

Generated from protobuf field int32 page_number = 1;

Parameters:

Parameter Type Description
$var integer

getPageSize

分页:每页条数,默认100

HaiUicListRequest::getPageSize(  ): integer

Generated from protobuf field int32 page_size = 2;


setPageSize

分页:每页条数,默认100

HaiUicListRequest::setPageSize( integer $var ): $this

Generated from protobuf field int32 page_size = 2;

Parameters:

Parameter Type Description
$var integer

getStatus

uic状态

HaiUicListRequest::getStatus(  ): integer

Generated from protobuf field .core.UicStatus status = 3;


setStatus

uic状态

HaiUicListRequest::setStatus( integer $var ): $this

Generated from protobuf field .core.UicStatus status = 3;

Parameters:

Parameter Type Description
$var integer

HaiUicListResponse

Generated from protobuf message plugin.HaiUicListResponse

  • Full name: \Akaxin\Proto\Plugin\HaiUicListResponse
  • Parent class:

__construct

HaiUicListResponse::__construct(  )

getUicInfo

查询的UIC结果

HaiUicListResponse::getUicInfo(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated .core.UicInfo uic_info = 1;


setUicInfo

查询的UIC结果

HaiUicListResponse::setUicInfo( array<mixed,\Akaxin\Proto\Core\UicInfo>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated .core.UicInfo uic_info = 1;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

getPageTotalNum

Generated from protobuf field int32 page_total_num = 2;

HaiUicListResponse::getPageTotalNum(  ): integer

setPageTotalNum

Generated from protobuf field int32 page_total_num = 2;

HaiUicListResponse::setPageTotalNum( integer $var ): $this

Parameters:

Parameter Type Description
$var integer

HaiUserGroupsRequest

* 获取用户的群组列表


接口名

/hai/user/groups 错误码


success error.alert

Generated from protobuf message plugin.HaiUserGroupsRequest

  • Full name: \Akaxin\Proto\Plugin\HaiUserGroupsRequest
  • Parent class:

__construct

HaiUserGroupsRequest::__construct(  )

getSiteUserId

需要查找的用户ID

HaiUserGroupsRequest::getSiteUserId(  ): string

Generated from protobuf field string site_user_id = 1;


setSiteUserId

需要查找的用户ID

HaiUserGroupsRequest::setSiteUserId( string $var ): $this

Generated from protobuf field string site_user_id = 1;

Parameters:

Parameter Type Description
$var string

getPageNumber

默认0

HaiUserGroupsRequest::getPageNumber(  ): integer

Generated from protobuf field int32 page_number = 3;


setPageNumber

默认0

HaiUserGroupsRequest::setPageNumber( integer $var ): $this

Generated from protobuf field int32 page_number = 3;

Parameters:

Parameter Type Description
$var integer

getPageSize

默认100

HaiUserGroupsRequest::getPageSize(  ): integer

Generated from protobuf field int32 page_size = 4;


setPageSize

默认100

HaiUserGroupsRequest::setPageSize( integer $var ): $this

Generated from protobuf field int32 page_size = 4;

Parameters:

Parameter Type Description
$var integer

HaiUserGroupsResponse

Generated from protobuf message plugin.HaiUserGroupsResponse

  • Full name: \Akaxin\Proto\Plugin\HaiUserGroupsResponse
  • Parent class:

__construct

HaiUserGroupsResponse::__construct(  )

getProfile

需要查找的用户

HaiUserGroupsResponse::getProfile(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated .core.GroupProfile profile = 1;


setProfile

需要查找的用户

HaiUserGroupsResponse::setProfile( array<mixed,\Akaxin\Proto\Core\GroupProfile>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated .core.GroupProfile profile = 1;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

getPageTotalNum

总页数

HaiUserGroupsResponse::getPageTotalNum(  ): integer

Generated from protobuf field int32 page_total_num = 2;


setPageTotalNum

总页数

HaiUserGroupsResponse::setPageTotalNum( integer $var ): $this

Generated from protobuf field int32 page_total_num = 2;

Parameters:

Parameter Type Description
$var integer

HaiUserListRequest

* 获取站点上用户


接口名

/hai/user/list 错误码


success error.alert

Generated from protobuf message plugin.HaiUserListRequest

  • Full name: \Akaxin\Proto\Plugin\HaiUserListRequest
  • Parent class:

__construct

HaiUserListRequest::__construct(  )

getPageNumber

分页:第几页

HaiUserListRequest::getPageNumber(  ): integer

Generated from protobuf field int32 page_number = 1;


setPageNumber

分页:第几页

HaiUserListRequest::setPageNumber( integer $var ): $this

Generated from protobuf field int32 page_number = 1;

Parameters:

Parameter Type Description
$var integer

getPageSize

分页:每页条数

HaiUserListRequest::getPageSize(  ): integer

Generated from protobuf field int32 page_size = 2;


setPageSize

分页:每页条数

HaiUserListRequest::setPageSize( integer $var ): $this

Generated from protobuf field int32 page_size = 2;

Parameters:

Parameter Type Description
$var integer

HaiUserListResponse

Generated from protobuf message plugin.HaiUserListResponse

  • Full name: \Akaxin\Proto\Plugin\HaiUserListResponse
  • Parent class:

__construct

HaiUserListResponse::__construct(  )

getUserProfile

查询的结果

HaiUserListResponse::getUserProfile(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated .core.SimpleUserProfile user_profile = 1;


setUserProfile

查询的结果

HaiUserListResponse::setUserProfile( array<mixed,\Akaxin\Proto\Core\SimpleUserProfile>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated .core.SimpleUserProfile user_profile = 1;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

getPageTotalNum

Generated from protobuf field int32 page_total_num = 2;

HaiUserListResponse::getPageTotalNum(  ): integer

setPageTotalNum

Generated from protobuf field int32 page_total_num = 2;

HaiUserListResponse::setPageTotalNum( integer $var ): $this

Parameters:

Parameter Type Description
$var integer

HaiUserPhoneRequest

* !! 这个文件需要重命名 !! 获取用户手机号


只有实名站点,才能获取此数据。 接口名


/hai/user/phone 错误码


success error.alert

Generated from protobuf message plugin.HaiUserPhoneRequest

  • Full name: \Akaxin\Proto\Plugin\HaiUserPhoneRequest
  • Parent class:

__construct

HaiUserPhoneRequest::__construct(  )

getSiteUserId

用户的站点ID

HaiUserPhoneRequest::getSiteUserId(  ): string

Generated from protobuf field string site_user_id = 1;


setSiteUserId

用户的站点ID

HaiUserPhoneRequest::setSiteUserId( string $var ): $this

Generated from protobuf field string site_user_id = 1;

Parameters:

Parameter Type Description
$var string

HaiUserPhoneResponse

Generated from protobuf message plugin.HaiUserPhoneResponse

  • Full name: \Akaxin\Proto\Plugin\HaiUserPhoneResponse
  • Parent class:

__construct

HaiUserPhoneResponse::__construct(  )

getCountryCode

国际区号+86

HaiUserPhoneResponse::getCountryCode(  ): string

Generated from protobuf field string country_code = 1;


setCountryCode

国际区号+86

HaiUserPhoneResponse::setCountryCode( string $var ): $this

Generated from protobuf field string country_code = 1;

Parameters:

Parameter Type Description
$var string

getPhoneId

手机号

HaiUserPhoneResponse::getPhoneId(  ): string

Generated from protobuf field string phone_id = 2;


setPhoneId

手机号

HaiUserPhoneResponse::setPhoneId( string $var ): $this

Generated from protobuf field string phone_id = 2;

Parameters:

Parameter Type Description
$var string

HaiUserProfileRequest

* 获取用户资料


接口名

/hai/user/profile 错误码


success error.alert

Generated from protobuf message plugin.HaiUserProfileRequest

  • Full name: \Akaxin\Proto\Plugin\HaiUserProfileRequest
  • Parent class:

__construct

HaiUserProfileRequest::__construct(  )

getSiteUserId

需要查找的用户ID

HaiUserProfileRequest::getSiteUserId(  ): string

Generated from protobuf field string site_user_id = 1;


setSiteUserId

需要查找的用户ID

HaiUserProfileRequest::setSiteUserId( string $var ): $this

Generated from protobuf field string site_user_id = 1;

Parameters:

Parameter Type Description
$var string

HaiUserProfileResponse

Generated from protobuf message plugin.HaiUserProfileResponse

  • Full name: \Akaxin\Proto\Plugin\HaiUserProfileResponse
  • Parent class:

__construct

HaiUserProfileResponse::__construct(  )

getUserProfile

需要查找的用户

HaiUserProfileResponse::getUserProfile(  ): \Akaxin\Proto\Core\UserProfile

Generated from protobuf field .core.UserProfile user_profile = 1;


setUserProfile

需要查找的用户

HaiUserProfileResponse::setUserProfile( \Akaxin\Proto\Core\UserProfile $var ): $this

Generated from protobuf field .core.UserProfile user_profile = 1;

Parameters:

Parameter Type Description
$var \Akaxin\Proto\Core\UserProfile

HaiUserRelationListRequest

* 获取用户好友~我没看懂这个接口是干什么的?


接口名

/hai/user/relationList 错误码


success error.alert

Generated from protobuf message plugin.HaiUserRelationListRequest

  • Full name: \Akaxin\Proto\Plugin\HaiUserRelationListRequest
  • Parent class:

__construct

HaiUserRelationListRequest::__construct(  )

getPageNumber

分页:第几页

HaiUserRelationListRequest::getPageNumber(  ): integer

Generated from protobuf field int32 page_number = 1;


setPageNumber

分页:第几页

HaiUserRelationListRequest::setPageNumber( integer $var ): $this

Generated from protobuf field int32 page_number = 1;

Parameters:

Parameter Type Description
$var integer

getPageSize

分页:每页条数

HaiUserRelationListRequest::getPageSize(  ): integer

Generated from protobuf field int32 page_size = 2;


setPageSize

分页:每页条数

HaiUserRelationListRequest::setPageSize( integer $var ): $this

Generated from protobuf field int32 page_size = 2;

Parameters:

Parameter Type Description
$var integer

HaiUserRelationListResponse

Generated from protobuf message plugin.HaiUserRelationListResponse

  • Full name: \Akaxin\Proto\Plugin\HaiUserRelationListResponse
  • Parent class:

__construct

HaiUserRelationListResponse::__construct(  )

getUserProfile

查询的结果

HaiUserRelationListResponse::getUserProfile(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated .core.UserRelationProfile user_profile = 1;


setUserProfile

查询的结果

HaiUserRelationListResponse::setUserProfile( array<mixed,\Akaxin\Proto\Core\UserRelationProfile>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated .core.UserRelationProfile user_profile = 1;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

getPageTotalNum

分页总数

HaiUserRelationListResponse::getPageTotalNum(  ): integer

Generated from protobuf field int32 page_total_num = 2;


setPageTotalNum

分页总数

HaiUserRelationListResponse::setPageTotalNum( integer $var ): $this

Generated from protobuf field int32 page_total_num = 2;

Parameters:

Parameter Type Description
$var integer

HaiUserSealUpRequest

* 禁封站点上用户,封禁的用户不能登陆该站点


接口名

/hai/user/sealUp 错误码


success error.alert

Generated from protobuf message plugin.HaiUserSealUpRequest

  • Full name: \Akaxin\Proto\Plugin\HaiUserSealUpRequest
  • Parent class:

__construct

HaiUserSealUpRequest::__construct(  )

getSiteUserId

需要删除的用户ID

HaiUserSealUpRequest::getSiteUserId(  ): string

Generated from protobuf field string site_user_id = 1;


setSiteUserId

需要删除的用户ID

HaiUserSealUpRequest::setSiteUserId( string $var ): $this

Generated from protobuf field string site_user_id = 1;

Parameters:

Parameter Type Description
$var string

getStatus

用户状态

HaiUserSealUpRequest::getStatus(  ): integer

Generated from protobuf field .core.UserStatus status = 2;


setStatus

用户状态

HaiUserSealUpRequest::setStatus( integer $var ): $this

Generated from protobuf field .core.UserStatus status = 2;

Parameters:

Parameter Type Description
$var integer

HaiUserSealUpResponse

Generated from protobuf message plugin.HaiUserSealUpResponse

  • Full name: \Akaxin\Proto\Plugin\HaiUserSealUpResponse
  • Parent class:

__construct

HaiUserSealUpResponse::__construct(  )

HaiUserSearchRequest

* 查找站点上用户,获取用户基本信息


接口名

/hai/user/search 错误码


success error.alert

Generated from protobuf message plugin.HaiUserSearchRequest

  • Full name: \Akaxin\Proto\Plugin\HaiUserSearchRequest
  • Parent class:

__construct

HaiUserSearchRequest::__construct(  )

getSiteUserId

需要查找的用户ID

HaiUserSearchRequest::getSiteUserId(  ): string

Generated from protobuf field string site_user_id = 1;


setSiteUserId

需要查找的用户ID

HaiUserSearchRequest::setSiteUserId( string $var ): $this

Generated from protobuf field string site_user_id = 1;

Parameters:

Parameter Type Description
$var string

getUserName

需要查找的用户名称(执行模糊查询)

HaiUserSearchRequest::getUserName(  ): string

Generated from protobuf field string user_name = 2;


setUserName

需要查找的用户名称(执行模糊查询)

HaiUserSearchRequest::setUserName( string $var ): $this

Generated from protobuf field string user_name = 2;

Parameters:

Parameter Type Description
$var string

getPageNumber

分页:第几页

HaiUserSearchRequest::getPageNumber(  ): integer

Generated from protobuf field int32 page_number = 3;


setPageNumber

分页:第几页

HaiUserSearchRequest::setPageNumber( integer $var ): $this

Generated from protobuf field int32 page_number = 3;

Parameters:

Parameter Type Description
$var integer

getPageSize

分页:每页条数,默认100

HaiUserSearchRequest::getPageSize(  ): integer

Generated from protobuf field int32 page_size = 4;


setPageSize

分页:每页条数,默认100

HaiUserSearchRequest::setPageSize( integer $var ): $this

Generated from protobuf field int32 page_size = 4;

Parameters:

Parameter Type Description
$var integer

HaiUserSearchResponse

Generated from protobuf message plugin.HaiUserSearchResponse

  • Full name: \Akaxin\Proto\Plugin\HaiUserSearchResponse
  • Parent class:

__construct

HaiUserSearchResponse::__construct(  )

getUserProfile

需要查找的用户

HaiUserSearchResponse::getUserProfile(  ): \Google\Protobuf\Internal\RepeatedField

Generated from protobuf field repeated .core.SimpleUserProfile user_profile = 1;


setUserProfile

需要查找的用户

HaiUserSearchResponse::setUserProfile( array<mixed,\Akaxin\Proto\Core\SimpleUserProfile>|\Google\Protobuf\Internal\RepeatedField $var ): $this

Generated from protobuf field repeated .core.SimpleUserProfile user_profile = 1;

Parameters:

Parameter Type Description
$var array|\Google\Protobuf\Internal\RepeatedField

getPageTotalNum

Generated from protobuf field int32 page_total_num = 2;

HaiUserSearchResponse::getPageTotalNum(  ): integer

setPageTotalNum

Generated from protobuf field int32 page_total_num = 2;

HaiUserSearchResponse::setPageTotalNum( integer $var ): $this

Parameters:

Parameter Type Description
$var integer

HaiUserUpdateRequest

* 更新用户信息


接口名

/hai/user/update 错误码


success error.alert

Generated from protobuf message plugin.HaiUserUpdateRequest

  • Full name: \Akaxin\Proto\Plugin\HaiUserUpdateRequest
  • Parent class:

__construct

HaiUserUpdateRequest::__construct(  )

getUserProfile

需要更新的用户信息

HaiUserUpdateRequest::getUserProfile(  ): \Akaxin\Proto\Core\UserProfile

Generated from protobuf field .core.UserProfile user_profile = 1;


setUserProfile

需要更新的用户信息

HaiUserUpdateRequest::setUserProfile( \Akaxin\Proto\Core\UserProfile $var ): $this

Generated from protobuf field .core.UserProfile user_profile = 1;

Parameters:

Parameter Type Description
$var \Akaxin\Proto\Core\UserProfile

HaiUserUpdateResponse

Generated from protobuf message plugin.HaiUserUpdateResponse

  • Full name: \Akaxin\Proto\Plugin\HaiUserUpdateResponse
  • Parent class:

__construct

HaiUserUpdateResponse::__construct(  )


This document was automatically generated from source code comments on 2018-05-31 using phpDocumentor and cvuorinen/phpdoc-markdown-public