NIM SDK API  8.5.0
Public Member Functions | List of all members
nim::TeamInfo Struct Reference

群组信息 More...

#include <nim_team_helper.h>

Public Member Functions

 TeamInfo (const std::string &team_id, const nim::NIMTeamType type)
 
 TeamInfo ()
 
void operator= (const TeamInfo &new_info)
 
void Update (const TeamInfo &new_info)
 
void SetTeamID (const std::string &id)
 
std::string GetTeamID () const
 
void SetName (const std::string &name)
 
std::string GetName () const
 
void SetType (nim::NIMTeamType type)
 
nim::NIMTeamType GetType () const
 
void SetOwnerID (const std::string &id)
 
std::string GetOwnerID () const
 
void SetMemberMaxCount (int count)
 
int GetMemberMaxCount () const
 
void SetProperty (const std::string &prop)
 
std::string GetProperty () const
 
void SetValid (bool valid)
 
bool IsValid () const
 
void SetMemberCount (int count)
 
int GetMemberCount () const
 
void SetMemberListTimetag (int64_t timetag)
 
int64_t GetMemberListTimetag () const
 
void SetCreateTimetag (int64_t timetag)
 
int64_t GetCreateTimetag () const
 
void SetUpdateTimetag (int64_t timetag)
 
int64_t GetUpdateTimetag () const
 
void SetMemberValid (bool valid)
 
bool IsMemberValid () const
 
void SetIntro (const std::string &intro)
 
std::string GetIntro () const
 
void SetAnnouncement (const std::string &announcement)
 
std::string GetAnnouncement () const
 
void SetJoinMode (nim::NIMTeamJoinMode mode)
 
nim::NIMTeamJoinMode GetJoinMode () const
 
void SetCustom (const std::string &custom)
 
std::string GetCustom () const
 
void SetServerCustom (const std::string &custom)
 
std::string GetServerCustom () const
 
void SetIcon (const std::string &icon)
 
std::string GetIcon () const
 
void SetBeInviteMode (NIMTeamBeInviteMode mode)
 
NIMTeamBeInviteMode GetBeInviteMode () const
 
void SetInviteMode (NIMTeamInviteMode mode)
 
NIMTeamInviteMode GetInviteMode () const
 
void SetUpdateInfoMode (NIMTeamUpdateInfoMode mode)
 
NIMTeamUpdateInfoMode GetUpdateInfoMode () const
 
void SetUpdateCustomMode (NIMTeamUpdateCustomMode mode)
 
NIMTeamUpdateCustomMode GetUpdateCustomMode () const
 
void SetMute (NIMTeamMuteType mute_type)
 
NIMTeamMuteType GetMuteType () const
 
bool ExistValue (const std::string &nim_team_info_key) const
 群组信息数据标记Key对应的数据是否有效(存在,非初始值状态) More...
 
std::string ToJsonString () const
 组装Json Value字符串 More...
 
nim_cpp_wrapper_util::Json::Value ToJsonValue () const
 获取JsonValue格式的数据 More...
 

Detailed Description

群组信息

Constructor & Destructor Documentation

◆ TeamInfo() [1/2]

nim::TeamInfo::TeamInfo ( const std::string &  team_id,
const nim::NIMTeamType  type 
)
inline

构造函数

◆ TeamInfo() [2/2]

nim::TeamInfo::TeamInfo ( )
inline

构造函数

Member Function Documentation

◆ ExistValue()

bool nim::TeamInfo::ExistValue ( const std::string &  nim_team_info_key) const
inline

群组信息数据标记Key对应的数据是否有效(存在,非初始值状态)

Parameters
[in]nim_team_info_key群组信息数据标记Key nim_team_def.h
Returns
bool 有效性

◆ GetAnnouncement()

std::string nim::TeamInfo::GetAnnouncement ( ) const
inline

获取群组公告

◆ GetBeInviteMode()

NIMTeamBeInviteMode nim::TeamInfo::GetBeInviteMode ( ) const
inline

获得被邀请人同意方式

◆ GetCreateTimetag()

int64_t nim::TeamInfo::GetCreateTimetag ( ) const
inline

获取群组创建时间戳(毫秒)

◆ GetCustom()

std::string nim::TeamInfo::GetCustom ( ) const
inline

获取群组客户端扩展内容

◆ GetIcon()

std::string nim::TeamInfo::GetIcon ( ) const
inline

获取群头像

◆ GetIntro()

std::string nim::TeamInfo::GetIntro ( ) const
inline

获取群组简介

◆ GetInviteMode()

NIMTeamInviteMode nim::TeamInfo::GetInviteMode ( ) const
inline

获取谁可以邀请他人入群

◆ GetJoinMode()

nim::NIMTeamJoinMode nim::TeamInfo::GetJoinMode ( ) const
inline

获取群组验证模式

◆ GetMemberCount()

int nim::TeamInfo::GetMemberCount ( ) const
inline

获取群组成员数量

◆ GetMemberListTimetag()

int64_t nim::TeamInfo::GetMemberListTimetag ( ) const
inline

获取群组成员档案时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置

◆ GetMemberMaxCount()

int nim::TeamInfo::GetMemberMaxCount ( ) const
inline

获取群的最大成员数

◆ GetMuteType()

NIMTeamMuteType nim::TeamInfo::GetMuteType ( ) const
inline

获取群禁言状态

◆ GetName()

std::string nim::TeamInfo::GetName ( ) const
inline

获取群组名字

◆ GetOwnerID()

std::string nim::TeamInfo::GetOwnerID ( ) const
inline

获取群组拥有者ID

◆ GetProperty()

std::string nim::TeamInfo::GetProperty ( ) const
inline

获取群组属性

◆ GetServerCustom()

std::string nim::TeamInfo::GetServerCustom ( ) const
inline

获取群组服务器端扩展内容

◆ GetTeamID()

std::string nim::TeamInfo::GetTeamID ( ) const
inline

获取群组ID

◆ GetType()

nim::NIMTeamType nim::TeamInfo::GetType ( ) const
inline

获取群组类型

◆ GetUpdateCustomMode()

NIMTeamUpdateCustomMode nim::TeamInfo::GetUpdateCustomMode ( ) const
inline

获取谁可以修改群资料属性

◆ GetUpdateInfoMode()

NIMTeamUpdateInfoMode nim::TeamInfo::GetUpdateInfoMode ( ) const
inline

获取谁可以修改群资料

◆ GetUpdateTimetag()

int64_t nim::TeamInfo::GetUpdateTimetag ( ) const
inline

获取群组更新时间戳(毫秒)

◆ IsMemberValid()

bool nim::TeamInfo::IsMemberValid ( ) const
inline

获取群组成员有效性

◆ IsValid()

bool nim::TeamInfo::IsValid ( ) const
inline

获取群组有效性

◆ operator=()

void nim::TeamInfo::operator= ( const TeamInfo new_info)
inline

重载=

◆ SetAnnouncement()

void nim::TeamInfo::SetAnnouncement ( const std::string &  announcement)
inline

设置群组公告

◆ SetBeInviteMode()

void nim::TeamInfo::SetBeInviteMode ( NIMTeamBeInviteMode  mode)
inline

设置被邀请人同意方式

◆ SetCreateTimetag()

void nim::TeamInfo::SetCreateTimetag ( int64_t  timetag)
inline

设置群组创建时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置

◆ SetCustom()

void nim::TeamInfo::SetCustom ( const std::string &  custom)
inline

群属性,开发者无需关注 20161011 by Oleg 获取群属性,开发者无需关注 20161011 by Oleg 设置群组客户端扩展内容

◆ SetIcon()

void nim::TeamInfo::SetIcon ( const std::string &  icon)
inline

设置群头像

◆ SetIntro()

void nim::TeamInfo::SetIntro ( const std::string &  intro)
inline

设置群组简介

◆ SetInviteMode()

void nim::TeamInfo::SetInviteMode ( NIMTeamInviteMode  mode)
inline

设置谁可以邀请他人入群

◆ SetJoinMode()

void nim::TeamInfo::SetJoinMode ( nim::NIMTeamJoinMode  mode)
inline

设置群组验证模式

◆ SetMemberCount()

void nim::TeamInfo::SetMemberCount ( int  count)
inline

设置群组成员数量,通常情况下由SDK维护,开发者作为只读无需设置

◆ SetMemberListTimetag()

void nim::TeamInfo::SetMemberListTimetag ( int64_t  timetag)
inline

设置群组成员档案时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置

◆ SetMemberMaxCount()

void nim::TeamInfo::SetMemberMaxCount ( int  count)
inline

在创建群时,设置群的最大成员数,不可超过应用设定的最大成员数,否则返回414

◆ SetMemberValid()

void nim::TeamInfo::SetMemberValid ( bool  valid)
inline

设置群组成员有效性,通常情况下由SDK维护,开发者作为只读无需设置

◆ SetMute()

void nim::TeamInfo::SetMute ( NIMTeamMuteType  mute_type)
inline

设置全员禁言(除管理员)

◆ SetName()

void nim::TeamInfo::SetName ( const std::string &  name)
inline

设置群组名字

◆ SetOwnerID()

void nim::TeamInfo::SetOwnerID ( const std::string &  id)
inline

设置群组拥有者ID,通常情况下由SDK维护,开发者作为只读无需设置

◆ SetProperty()

void nim::TeamInfo::SetProperty ( const std::string &  prop)
inline

设置群组属性

◆ SetServerCustom()

void nim::TeamInfo::SetServerCustom ( const std::string &  custom)
inline

设置群组服务器端扩展内容

◆ SetTeamID()

void nim::TeamInfo::SetTeamID ( const std::string &  id)
inline

设置群组ID,通常情况下由SDK维护,开发者作为只读无需设置

◆ SetType()

void nim::TeamInfo::SetType ( nim::NIMTeamType  type)
inline

设置群组类型

◆ SetUpdateCustomMode()

void nim::TeamInfo::SetUpdateCustomMode ( NIMTeamUpdateCustomMode  mode)
inline

设置谁可以修改群资料属性

◆ SetUpdateInfoMode()

void nim::TeamInfo::SetUpdateInfoMode ( NIMTeamUpdateInfoMode  mode)
inline

设置谁可以修改群资料

◆ SetUpdateTimetag()

void nim::TeamInfo::SetUpdateTimetag ( int64_t  timetag)
inline

设置群组更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置

◆ SetValid()

void nim::TeamInfo::SetValid ( bool  valid)
inline

设置群组有效性,通常情况下由SDK维护,开发者作为只读无需设置

◆ ToJsonString()

std::string nim::TeamInfo::ToJsonString ( ) const
inline

组装Json Value字符串

Returns
string Json Value字符串

◆ ToJsonValue()

nim_cpp_wrapper_util::Json::Value nim::TeamInfo::ToJsonValue ( ) const
inline

获取JsonValue格式的数据

Returns
nim_cpp_wrapper_util::Json::Value

◆ Update()

void nim::TeamInfo::Update ( const TeamInfo new_info)
inline

更新


The documentation for this struct was generated from the following file: